From aec26cb11f5d83cae79cb85b77e979a74019e3c5 Mon Sep 17 00:00:00 2001 From: Jen Young <165731018+jyoung-dbx@users.noreply.github.com> Date: Fri, 6 Dec 2024 07:30:24 -0800 Subject: [PATCH 01/16] Update fax file descriptions and fix typo (#461) --- openapi-sdk.yaml | 6 ++--- openapi.yaml | 6 ++--- sdks/dotnet/README.md | 2 +- sdks/dotnet/docs/FaxApi.md | 8 +++---- sdks/dotnet/docs/FaxLineApi.md | 2 +- sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs | 24 +++++++++---------- .../dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs | 16 ++++++------- sdks/java-v1/README.md | 2 +- sdks/java-v1/docs/FaxApi.md | 6 ++--- sdks/java-v1/docs/FaxLineApi.md | 2 +- .../java/com/dropbox/sign/api/FaxApi.java | 4 ++-- .../java/com/dropbox/sign/api/FaxLineApi.java | 4 ++-- sdks/java-v2/README.md | 2 +- sdks/java-v2/docs/FaxApi.md | 6 ++--- sdks/java-v2/docs/FaxLineApi.md | 2 +- .../java/com/dropbox/sign/api/FaxApi.java | 8 +++---- .../java/com/dropbox/sign/api/FaxLineApi.java | 4 ++-- sdks/node/README.md | 2 +- sdks/node/api/faxApi.ts | 4 ++-- sdks/node/api/faxLineApi.ts | 2 +- sdks/node/docs/api/FaxApi.md | 6 ++--- sdks/node/docs/api/FaxLineApi.md | 2 +- sdks/php/README.md | 2 +- sdks/php/docs/Api/FaxApi.md | 6 ++--- sdks/php/docs/Api/FaxLineApi.md | 2 +- sdks/php/src/Api/FaxApi.php | 8 +++---- sdks/python/README.md | 2 +- sdks/python/docs/FaxApi.md | 6 ++--- sdks/python/docs/FaxLineApi.md | 2 +- sdks/python/dropbox_sign/api/fax_api.py | 12 +++++----- sdks/python/dropbox_sign/api/fax_line_api.py | 6 ++--- sdks/ruby/README.md | 2 +- sdks/ruby/docs/FaxApi.md | 8 +++---- sdks/ruby/docs/FaxLineApi.md | 2 +- sdks/ruby/lib/dropbox-sign/api/fax_api.rb | 8 +++---- .../ruby/lib/dropbox-sign/api/fax_line_api.rb | 4 ++-- translations/en.yaml | 6 ++--- 37 files changed, 98 insertions(+), 98 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 608b57dd4..c16c64152 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1609,8 +1609,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads fax files' operationId: faxFiles parameters: - @@ -1812,7 +1812,7 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a response with the area codes available for a given state/province and city.' operationId: faxLineAreaCodeGet parameters: - diff --git a/openapi.yaml b/openapi.yaml index faa843be3..00ff9635c 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1609,8 +1609,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads fax files' operationId: faxFiles parameters: - @@ -1812,7 +1812,7 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a response with the area codes available for a given state/province and city.' operationId: faxLineAreaCodeGet parameters: - diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index df751f711..104db3486 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -142,7 +142,7 @@ Class | Method | HTTP request | Description *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* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download 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 diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md index 303d4eff9..207d25611 100644 --- a/sdks/dotnet/docs/FaxApi.md +++ b/sdks/dotnet/docs/FaxApi.md @@ -5,7 +5,7 @@ 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 | +| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download 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 | @@ -100,9 +100,9 @@ void (empty response body) # **FaxFiles** > System.IO.Stream FaxFiles (string faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example ```csharp @@ -149,7 +149,7 @@ This returns an ApiResponse object which contains the response data, status code ```csharp try { - // List Fax Files + // Download Fax Files ApiResponse response = apiInstance.FaxFilesWithHttpInfo(faxId); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); diff --git a/sdks/dotnet/docs/FaxLineApi.md b/sdks/dotnet/docs/FaxLineApi.md index 9fdd09ba0..ea3109c8a 100644 --- a/sdks/dotnet/docs/FaxLineApi.md +++ b/sdks/dotnet/docs/FaxLineApi.md @@ -113,7 +113,7 @@ catch (ApiException e) Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example ```csharp diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs index b9819df28..5ff4251f5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -51,10 +51,10 @@ public interface IFaxApiSync : IApiAccessor /// ApiResponse of Object(void) ApiResponse FaxDeleteWithHttpInfo(string faxId, int operationIndex = 0); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -63,10 +63,10 @@ public interface IFaxApiSync : IApiAccessor System.IO.Stream FaxFiles(string faxId, int operationIndex = 0); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -179,10 +179,10 @@ public interface IFaxApiAsync : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> FaxDeleteWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -192,10 +192,10 @@ public interface IFaxApiAsync : IApiAccessor System.Threading.Tasks.Task FaxFilesAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -555,7 +555,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -568,7 +568,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -632,7 +632,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -646,7 +646,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs index edb0eb516..38f303895 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs @@ -54,7 +54,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -69,7 +69,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -238,7 +238,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -254,7 +254,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -689,7 +689,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -705,7 +705,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -783,7 +783,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -800,7 +800,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index 9d6eaa6cb..d5f7354bc 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -178,7 +178,7 @@ Class | Method | HTTP request | Description *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* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download 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 diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md index a3d9baef9..16102c5a4 100644 --- a/sdks/java-v1/docs/FaxApi.md +++ b/sdks/java-v1/docs/FaxApi.md @@ -5,7 +5,7 @@ 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 +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download 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 @@ -82,9 +82,9 @@ null (empty response body) > File faxFiles(faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/java-v1/docs/FaxLineApi.md b/sdks/java-v1/docs/FaxLineApi.md index 1997f1f12..3aa4f8c4c 100644 --- a/sdks/java-v1/docs/FaxLineApi.md +++ b/sdks/java-v1/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java index ce101cc84..bf79b4f83 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -113,7 +113,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** - * List Fax Files. Returns list of fax files + * Download Fax Files. Downloads fax files * * @param faxId Fax ID (required) * @return File @@ -130,7 +130,7 @@ public File faxFiles(String faxId) throws ApiException { } /** - * List Fax Files. Returns list of fax files + * Download Fax Files. Downloads fax files * * @param faxId Fax ID (required) * @return ApiResponse<File> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 8d67ba4f1..6f35fb7aa 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -121,7 +121,7 @@ public ApiResponse faxLineAddUserWithHttpInfo( /** * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/provice and city. + * given state/province and city. * * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) @@ -208,7 +208,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( /** * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/provice and city. + * given state/province and city. * * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index d9afebf2b..c012f8fdb 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -154,7 +154,7 @@ Class | Method | HTTP request | Description *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* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download 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 diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md index a3d9baef9..16102c5a4 100644 --- a/sdks/java-v2/docs/FaxApi.md +++ b/sdks/java-v2/docs/FaxApi.md @@ -5,7 +5,7 @@ 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 +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download 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 @@ -82,9 +82,9 @@ null (empty response body) > File faxFiles(faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/java-v2/docs/FaxLineApi.md b/sdks/java-v2/docs/FaxLineApi.md index 1997f1f12..3aa4f8c4c 100644 --- a/sdks/java-v2/docs/FaxLineApi.md +++ b/sdks/java-v2/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java index e010c8323..a42076f38 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -114,8 +114,8 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException ); } /** - * List Fax Files. - * Returns list of fax files + * Download Fax Files. + * Downloads fax files * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -132,8 +132,8 @@ public File faxFiles(String faxId) throws ApiException { /** - * List Fax Files. - * Returns list of fax files + * Download Fax Files. + * Downloads fax files * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 3555e15cd..c6d9a5eea 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -116,7 +116,7 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq } /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/provice and city. + * Returns a response with the area codes available for a given state/province and city. * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) * @param province Filter area codes by province. (optional) @@ -198,7 +198,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/provice and city. + * Returns a response with the area codes available for a given state/province and city. * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) * @param province Filter area codes by province. (optional) diff --git a/sdks/node/README.md b/sdks/node/README.md index bfee7884f..7e05e443f 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -121,7 +121,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *EmbeddedApi* | [**embeddedEditUrl**](./docs/api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](./docs/api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | | *FaxApi* | [**faxDelete**](./docs/api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | *FaxApi* | [**faxGet**](./docs/api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | | *FaxApi* | [**faxList**](./docs/api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | | *FaxApi* | [**faxSend**](./docs/api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts index dd9c6df2a..fdb7f9e9f 100644 --- a/sdks/node/api/faxApi.ts +++ b/sdks/node/api/faxApi.ts @@ -220,8 +220,8 @@ export class FaxApi { }); } /** - * Returns list of fax files - * @summary List Fax Files + * Downloads fax files + * @summary Download Fax Files * @param faxId Fax ID * @param options */ diff --git a/sdks/node/api/faxLineApi.ts b/sdks/node/api/faxLineApi.ts index 634f6149a..e9ca6c40d 100644 --- a/sdks/node/api/faxLineApi.ts +++ b/sdks/node/api/faxLineApi.ts @@ -261,7 +261,7 @@ export class FaxLineApi { }); } /** - * Returns a response with the area codes available for a given state/provice and city. + * Returns a response with the area codes available for a given state/province and city. * @summary Get Available Fax Line Area Codes * @param country Filter area codes by country. * @param state Filter area codes by state. diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md index 84ccc7b39..775241da2 100644 --- a/sdks/node/docs/api/FaxApi.md +++ b/sdks/node/docs/api/FaxApi.md @@ -5,7 +5,7 @@ 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 | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download 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 | @@ -88,9 +88,9 @@ void (empty response body) faxFiles(faxId: string): Buffer ``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### TypeScript Example diff --git a/sdks/node/docs/api/FaxLineApi.md b/sdks/node/docs/api/FaxLineApi.md index 4d9f6208b..ab90dd93e 100644 --- a/sdks/node/docs/api/FaxLineApi.md +++ b/sdks/node/docs/api/FaxLineApi.md @@ -104,7 +104,7 @@ faxLineAreaCodeGet(country: 'CA' | 'US' | 'UK', state: 'AK' | 'AL' | 'AR' | 'AZ' Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### TypeScript Example diff --git a/sdks/php/README.md b/sdks/php/README.md index ef4b2677f..946c74e1f 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -161,7 +161,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *EmbeddedApi* | [**embeddedEditUrl**](docs/Api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](docs/Api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | | *FaxApi* | [**faxDelete**](docs/Api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | *FaxApi* | [**faxGet**](docs/Api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | | *FaxApi* | [**faxList**](docs/Api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | | *FaxApi* | [**faxSend**](docs/Api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 8b68458c6..78e411118 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -5,7 +5,7 @@ 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 | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download 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 | @@ -72,9 +72,9 @@ void (empty response body) ```php faxFiles($fax_id): \SplFileObject ``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index 1bb340d36..44789fc33 100644 --- a/sdks/php/docs/Api/FaxLineApi.md +++ b/sdks/php/docs/Api/FaxLineApi.md @@ -81,7 +81,7 @@ faxLineAreaCodeGet($country, $state, $province, $city): \Dropbox\Sign\Model\FaxL ``` Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index 0ae0cf38d..619778c5b 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -385,7 +385,7 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con /** * Operation faxFiles * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @@ -402,7 +402,7 @@ public function faxFiles(string $fax_id) /** * Operation faxFilesWithHttpInfo * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation @@ -539,7 +539,7 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: /** * Operation faxFilesAsync * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation @@ -561,7 +561,7 @@ function ($response) { /** * Operation faxFilesAsyncWithHttpInfo * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation diff --git a/sdks/python/README.md b/sdks/python/README.md index 77ebb1aa4..c74588445 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -116,7 +116,7 @@ Class | Method | HTTP request | Description |```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL| ```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL| |```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| -```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files| ```FaxApi``` | [```fax_get```](docs/FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| ```FaxApi``` | [```fax_list```](docs/FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| ```FaxApi``` | [```fax_send```](docs/FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md index a0b2cbd12..93ec15305 100644 --- a/sdks/python/docs/FaxApi.md +++ b/sdks/python/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- |[```fax_delete```](FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| -|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files| |[```fax_get```](FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| |[```fax_list```](FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| |[```fax_send```](FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| @@ -73,9 +73,9 @@ void (empty response body) # ```fax_files``` > ```io.IOBase fax_files(fax_id)``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 27ec4d08b..0846b3384 100644 --- a/sdks/python/docs/FaxLineApi.md +++ b/sdks/python/docs/FaxLineApi.md @@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client: Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 3e49a160a..695dd29c9 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -301,9 +301,9 @@ def fax_files( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> io.IOBase: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads fax files :param fax_id: Fax ID (required) :type fax_id: str @@ -366,9 +366,9 @@ def fax_files_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[io.IOBase]: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads fax files :param fax_id: Fax ID (required) :type fax_id: str @@ -431,9 +431,9 @@ def fax_files_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads fax files :param fax_id: Fax ID (required) :type fax_id: str diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index 2fbb5ac99..e32d2b234 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -352,7 +352,7 @@ def fax_line_area_code_get( ) -> FaxLineAreaCodeGetResponse: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a response with the area codes available for a given state/province and city. :param country: Filter area codes by country. (required) :type country: str @@ -437,7 +437,7 @@ def fax_line_area_code_get_with_http_info( ) -> ApiResponse[FaxLineAreaCodeGetResponse]: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a response with the area codes available for a given state/province and city. :param country: Filter area codes by country. (required) :type country: str @@ -522,7 +522,7 @@ def fax_line_area_code_get_without_preload_content( ) -> RESTResponseType: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a response with the area codes available for a given state/province and city. :param country: Filter area codes by country. (required) :type country: str diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index a30ca97c0..87678fae4 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -122,7 +122,7 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | |*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax | -|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files | +|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | Download Fax Files | |*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax | |*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes | |*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax | diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md index 23129b6d7..a0e05a605 100644 --- a/sdks/ruby/docs/FaxApi.md +++ b/sdks/ruby/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax | -| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | List Fax Files | +| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | Download Fax Files | | [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax | | [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes | | [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax | @@ -81,9 +81,9 @@ nil (empty response body) > `File fax_files(fax_id)` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Examples @@ -116,7 +116,7 @@ This returns an Array which contains the response data, status code and headers. ```ruby begin - # List Fax Files + # Download Fax Files data, status_code, headers = api_instance.fax_files_with_http_info(fax_id) p status_code # => 2xx p headers # => { ... } diff --git a/sdks/ruby/docs/FaxLineApi.md b/sdks/ruby/docs/FaxLineApi.md index f5b1d3b43..49309267e 100644 --- a/sdks/ruby/docs/FaxLineApi.md +++ b/sdks/ruby/docs/FaxLineApi.md @@ -90,7 +90,7 @@ end Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Examples diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index 17fca7916..2df3c1851 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -89,8 +89,8 @@ def fax_delete_with_http_info(fax_id, opts = {}) return data, status_code, headers end - # List Fax Files - # Returns list of fax files + # Download Fax Files + # Downloads fax files # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -99,8 +99,8 @@ def fax_files(fax_id, opts = {}) data end - # List Fax Files - # Returns list of fax files + # Download Fax Files + # Downloads fax files # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb index 7adb326d6..a0b9677db 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -132,7 +132,7 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/provice and city. + # Returns a response with the area codes available for a given state/province and city. # @param country [String] Filter area codes by country. # @param [Hash] opts the optional parameters # @option opts [String] :state Filter area codes by state. @@ -145,7 +145,7 @@ def fax_line_area_code_get(country, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/provice and city. + # Returns a response with the area codes available for a given state/province and city. # @param country [String] Filter area codes by country. # @param [Hash] opts the optional parameters # @option opts [String] :state Filter area codes by state. diff --git a/translations/en.yaml b/translations/en.yaml index 553da26d9..52a9b3559 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -135,8 +135,8 @@ "FaxParam::FAX_ID": Fax ID "FaxDelete::SUMMARY": Delete Fax "FaxDelete::DESCRIPTION": Deletes the specified Fax from the system. -"FaxFiles::SUMMARY": List Fax Files -"FaxFiles::DESCRIPTION": Returns list of fax files +"FaxFiles::SUMMARY": Download Fax Files +"FaxFiles::DESCRIPTION": Downloads fax files "FaxList::SUMMARY": Lists Faxes "FaxList::DESCRIPTION": Returns properties of multiple faxes "FaxList::PAGE": Page @@ -175,7 +175,7 @@ "FaxLineAddUser::ACCOUNT_ID": Account ID "FaxLineAddUser::EMAIL_ADDRESS": Email address "FaxLineAreaCodeGet::SUMMARY": Get Available Fax Line Area Codes -"FaxLineAreaCodeGet::DESCRIPTION": Returns a response with the area codes available for a given state/provice and city. +"FaxLineAreaCodeGet::DESCRIPTION": Returns a response with the area codes available for a given state/province and city. "FaxLineAreaCodeGet::CITY": Filter area codes by city. "FaxLineAreaCodeGet::STATE": Filter area codes by state. "FaxLineAreaCodeGet::PROVINCE": Filter area codes by province. From 16f6776618ef00eb9dfa411357ad1d2d384947dc Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Thu, 12 Dec 2024 11:10:01 -0600 Subject: [PATCH 02/16] Fix response codes to be strings (#465) --- openapi-sdk.yaml | 276 +++++++++++++++++----------------- openapi.yaml | 276 +++++++++++++++++----------------- src/Hello/OpenApi/RawFile.php | 15 ++ 3 files changed, 291 insertions(+), 276 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index c16c64152..c2d51ea54 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -32,7 +32,7 @@ paths: oauth: $ref: '#/components/examples/AccountCreateRequestOAuthExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -50,7 +50,7 @@ paths: $ref: '#/components/examples/AccountCreateResponseExample' oauth: $ref: '#/components/examples/AccountCreateOAuthResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -147,7 +147,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -163,7 +163,7 @@ paths: examples: default_example: $ref: '#/components/examples/AccountGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -248,7 +248,7 @@ paths: default_example: $ref: '#/components/examples/AccountUpdateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -264,7 +264,7 @@ paths: examples: default_example: $ref: '#/components/examples/AccountUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -351,7 +351,7 @@ paths: default_example: $ref: '#/components/examples/AccountVerifyRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -369,7 +369,7 @@ paths: $ref: '#/components/examples/AccountVerifyFoundResponseExample' not_found: $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -457,7 +457,7 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -473,7 +473,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -560,7 +560,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -576,7 +576,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -676,7 +676,7 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -692,7 +692,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -780,7 +780,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -789,7 +789,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -882,7 +882,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -898,7 +898,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -997,7 +997,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1013,7 +1013,7 @@ paths: examples: default_example: $ref: '#/components/examples/BulkSendJobGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1105,7 +1105,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1121,7 +1121,7 @@ paths: examples: default_example: $ref: '#/components/examples/BulkSendJobListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1216,7 +1216,7 @@ paths: default_example: $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1232,7 +1232,7 @@ paths: examples: default_example: $ref: '#/components/examples/EmbeddedEditUrlResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1319,7 +1319,7 @@ paths: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1335,7 +1335,7 @@ paths: examples: default_example: $ref: '#/components/examples/EmbeddedSignUrlResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1426,7 +1426,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1442,7 +1442,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1527,7 +1527,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1536,7 +1536,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1622,7 +1622,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1636,7 +1636,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1724,7 +1724,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineAddUserRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1740,7 +1740,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1911,7 +1911,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1927,7 +1927,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2009,7 +2009,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineCreateRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2025,7 +2025,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2108,7 +2108,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2124,7 +2124,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2207,7 +2207,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineDeleteRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2218,7 +2218,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2323,7 +2323,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2339,7 +2339,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2421,7 +2421,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineRemoveUserRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2437,7 +2437,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2532,7 +2532,7 @@ paths: minimum: 1 example: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2548,7 +2548,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2633,7 +2633,7 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2649,7 +2649,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2735,7 +2735,7 @@ paths: default_example: $ref: '#/components/examples/OAuthTokenGenerateRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2751,7 +2751,7 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2835,7 +2835,7 @@ paths: default_example: $ref: '#/components/examples/OAuthTokenRefreshRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2851,7 +2851,7 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2938,7 +2938,7 @@ paths: default_example: $ref: '#/components/examples/ReportCreateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2954,7 +2954,7 @@ paths: examples: default_example: $ref: '#/components/examples/ReportCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3042,7 +3042,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3058,7 +3058,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3152,7 +3152,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3168,7 +3168,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3265,7 +3265,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3276,7 +3276,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3373,7 +3373,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3389,7 +3389,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3481,7 +3481,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3497,7 +3497,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3599,7 +3599,7 @@ paths: - pdf - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3617,7 +3617,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3714,7 +3714,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3730,7 +3730,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3834,7 +3834,7 @@ paths: type: integer default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3850,7 +3850,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3944,7 +3944,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3960,7 +3960,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4072,7 +4072,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4088,7 +4088,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4176,7 +4176,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4192,7 +4192,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4291,7 +4291,7 @@ paths: default_example: $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4307,7 +4307,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestRemindResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4406,7 +4406,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4417,7 +4417,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4510,7 +4510,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4526,7 +4526,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestSendResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4619,7 +4619,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4635,7 +4635,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4737,7 +4737,7 @@ paths: default_example: $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4753,7 +4753,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4851,7 +4851,7 @@ paths: account_id: $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4867,7 +4867,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamAddMemberResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4954,7 +4954,7 @@ paths: default_example: $ref: '#/components/examples/TeamCreateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4970,7 +4970,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5046,7 +5046,7 @@ paths: description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' operationId: teamDelete responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5055,7 +5055,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5131,7 +5131,7 @@ paths: description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' operationId: teamGet responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5147,7 +5147,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5233,7 +5233,7 @@ paths: default_example: $ref: '#/components/examples/TeamUpdateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5249,7 +5249,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5334,7 +5334,7 @@ paths: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5350,7 +5350,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamGetInfoResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5438,7 +5438,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5454,7 +5454,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamInvitesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5556,7 +5556,7 @@ paths: maximum: 100 minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5572,7 +5572,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamMembersResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5663,7 +5663,7 @@ paths: account_id: $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5679,7 +5679,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamRemoveMemberResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5782,7 +5782,7 @@ paths: maximum: 100 minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5798,7 +5798,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamSubTeamsResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5896,7 +5896,7 @@ paths: default_example: $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5912,7 +5912,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateAddUserResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6008,7 +6008,7 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6024,7 +6024,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6122,7 +6122,7 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6138,7 +6138,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6227,7 +6227,7 @@ paths: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6238,7 +6238,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6339,7 +6339,7 @@ paths: - pdf - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6357,7 +6357,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6453,7 +6453,7 @@ paths: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6469,7 +6469,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6572,7 +6572,7 @@ paths: type: integer default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6588,7 +6588,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6681,7 +6681,7 @@ paths: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6697,7 +6697,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6809,7 +6809,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6825,7 +6825,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6923,7 +6923,7 @@ paths: default_example: $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6939,7 +6939,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateRemoveUserResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7050,7 +7050,7 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7066,7 +7066,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7166,7 +7166,7 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7182,7 +7182,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7279,7 +7279,7 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7295,7 +7295,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7391,7 +7391,7 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7407,7 +7407,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7510,7 +7510,7 @@ paths: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7526,7 +7526,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' - 4XX: + '4XX': description: failed_operation content: application/json: diff --git a/openapi.yaml b/openapi.yaml index 00ff9635c..f6ae63aec 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -32,7 +32,7 @@ paths: oauth: $ref: '#/components/examples/AccountCreateRequestOAuthExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -50,7 +50,7 @@ paths: $ref: '#/components/examples/AccountCreateResponseExample' oauth: $ref: '#/components/examples/AccountCreateOAuthResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -147,7 +147,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -163,7 +163,7 @@ paths: examples: default_example: $ref: '#/components/examples/AccountGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -248,7 +248,7 @@ paths: default_example: $ref: '#/components/examples/AccountUpdateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -264,7 +264,7 @@ paths: examples: default_example: $ref: '#/components/examples/AccountUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -351,7 +351,7 @@ paths: default_example: $ref: '#/components/examples/AccountVerifyRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -369,7 +369,7 @@ paths: $ref: '#/components/examples/AccountVerifyFoundResponseExample' not_found: $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -457,7 +457,7 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -473,7 +473,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -560,7 +560,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -576,7 +576,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -676,7 +676,7 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -692,7 +692,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -780,7 +780,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -789,7 +789,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -882,7 +882,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -898,7 +898,7 @@ paths: examples: default_example: $ref: '#/components/examples/ApiAppListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -997,7 +997,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1013,7 +1013,7 @@ paths: examples: default_example: $ref: '#/components/examples/BulkSendJobGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1105,7 +1105,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1121,7 +1121,7 @@ paths: examples: default_example: $ref: '#/components/examples/BulkSendJobListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1216,7 +1216,7 @@ paths: default_example: $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1232,7 +1232,7 @@ paths: examples: default_example: $ref: '#/components/examples/EmbeddedEditUrlResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1319,7 +1319,7 @@ paths: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1335,7 +1335,7 @@ paths: examples: default_example: $ref: '#/components/examples/EmbeddedSignUrlResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1426,7 +1426,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1442,7 +1442,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1527,7 +1527,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1536,7 +1536,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1622,7 +1622,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1636,7 +1636,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1724,7 +1724,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineAddUserRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1740,7 +1740,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1911,7 +1911,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1927,7 +1927,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2009,7 +2009,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineCreateRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2025,7 +2025,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2108,7 +2108,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2124,7 +2124,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2207,7 +2207,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineDeleteRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2218,7 +2218,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2323,7 +2323,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2339,7 +2339,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2421,7 +2421,7 @@ paths: default_example: $ref: '#/components/examples/FaxLineRemoveUserRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2437,7 +2437,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2532,7 +2532,7 @@ paths: minimum: 1 example: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2548,7 +2548,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2633,7 +2633,7 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2649,7 +2649,7 @@ paths: examples: default_example: $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2735,7 +2735,7 @@ paths: default_example: $ref: '#/components/examples/OAuthTokenGenerateRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2751,7 +2751,7 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2835,7 +2835,7 @@ paths: default_example: $ref: '#/components/examples/OAuthTokenRefreshRequestExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2851,7 +2851,7 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2938,7 +2938,7 @@ paths: default_example: $ref: '#/components/examples/ReportCreateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2954,7 +2954,7 @@ paths: examples: default_example: $ref: '#/components/examples/ReportCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3042,7 +3042,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3058,7 +3058,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3152,7 +3152,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3168,7 +3168,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3265,7 +3265,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3276,7 +3276,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3373,7 +3373,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3389,7 +3389,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3481,7 +3481,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3497,7 +3497,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3599,7 +3599,7 @@ paths: - pdf - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3617,7 +3617,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3714,7 +3714,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3730,7 +3730,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3834,7 +3834,7 @@ paths: type: integer default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3850,7 +3850,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3944,7 +3944,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3960,7 +3960,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4072,7 +4072,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4088,7 +4088,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4176,7 +4176,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4192,7 +4192,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4291,7 +4291,7 @@ paths: default_example: $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4307,7 +4307,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestRemindResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4406,7 +4406,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4417,7 +4417,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4510,7 +4510,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4526,7 +4526,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestSendResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4619,7 +4619,7 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4635,7 +4635,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4737,7 +4737,7 @@ paths: default_example: $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4753,7 +4753,7 @@ paths: examples: default_example: $ref: '#/components/examples/SignatureRequestUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4851,7 +4851,7 @@ paths: account_id: $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4867,7 +4867,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamAddMemberResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -4954,7 +4954,7 @@ paths: default_example: $ref: '#/components/examples/TeamCreateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4970,7 +4970,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5046,7 +5046,7 @@ paths: description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' operationId: teamDelete responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5055,7 +5055,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5131,7 +5131,7 @@ paths: description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' operationId: teamGet responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5147,7 +5147,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5233,7 +5233,7 @@ paths: default_example: $ref: '#/components/examples/TeamUpdateRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5249,7 +5249,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamUpdateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5334,7 +5334,7 @@ paths: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5350,7 +5350,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamGetInfoResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5438,7 +5438,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5454,7 +5454,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamInvitesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5556,7 +5556,7 @@ paths: maximum: 100 minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5572,7 +5572,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamMembersResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5663,7 +5663,7 @@ paths: account_id: $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5679,7 +5679,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamRemoveMemberResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5782,7 +5782,7 @@ paths: maximum: 100 minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5798,7 +5798,7 @@ paths: examples: default_example: $ref: '#/components/examples/TeamSubTeamsResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5896,7 +5896,7 @@ paths: default_example: $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5912,7 +5912,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateAddUserResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6008,7 +6008,7 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6024,7 +6024,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6122,7 +6122,7 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6138,7 +6138,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6227,7 +6227,7 @@ paths: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6238,7 +6238,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6339,7 +6339,7 @@ paths: - pdf - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6357,7 +6357,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6453,7 +6453,7 @@ paths: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6469,7 +6469,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6572,7 +6572,7 @@ paths: type: integer default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6588,7 +6588,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6681,7 +6681,7 @@ paths: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6697,7 +6697,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateGetResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6809,7 +6809,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6825,7 +6825,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateListResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -6923,7 +6923,7 @@ paths: default_example: $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6939,7 +6939,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateRemoveUserResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7050,7 +7050,7 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7066,7 +7066,7 @@ paths: examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7166,7 +7166,7 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7182,7 +7182,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7279,7 +7279,7 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7295,7 +7295,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7391,7 +7391,7 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7407,7 +7407,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -7510,7 +7510,7 @@ paths: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7526,7 +7526,7 @@ paths: examples: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' - 4XX: + '4XX': description: failed_operation content: application/json: diff --git a/src/Hello/OpenApi/RawFile.php b/src/Hello/OpenApi/RawFile.php index 85f902fb5..0ecfe46a2 100644 --- a/src/Hello/OpenApi/RawFile.php +++ b/src/Hello/OpenApi/RawFile.php @@ -98,6 +98,20 @@ public function getLogs(): array public function saveFile(string $targetFile): void { + foreach ($this->openapi['paths'] as $path => $path_item) { + foreach ($path_item as $method => $operation) { + if (empty($operation['responses'])) { + continue; + } + + foreach ($operation['responses'] as $code => $response) { + unset($this->openapi['paths'][$path][$method]['responses'][$code]); + $new_code = "{$code}_response_code_remove_me"; + $this->openapi['paths'][$path][$method]['responses'][$new_code] = $response; + } + } + } + $yaml = Yaml::dump( $this->openapi, 10, @@ -112,6 +126,7 @@ public function saveFile(string $targetFile): void $yaml = str_replace('metadata: []', 'metadata: {}', $yaml); $yaml = str_replace('additionalProperties: []', 'additionalProperties: {}', $yaml); $yaml = str_replace('application/json: []', 'application/json: {}', $yaml); + $yaml = preg_replace('/([0-9x]+)_response_code_remove_me:/i', '\'${1}\':', $yaml); file_put_contents($targetFile, $yaml); } From 9340ecf4242a5bc71555839bca3f4b36996ff21d Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Wed, 29 Jan 2025 12:53:02 -0600 Subject: [PATCH 03/16] Some fixes for the OAS (#466) --- examples/ApiAppUpdate.php | 2 +- examples/ApiAppUpdate.py | 2 +- examples/ApiAppUpdate.rb | 2 +- examples/ApiAppUpdate.sh | 2 +- examples/ApiAppUpdate.ts | 2 +- examples/json/ApiAppCreateResponseExample.json | 2 +- examples/json/ApiAppGetResponseExample.json | 2 +- examples/json/ApiAppListResponseExample.json | 2 +- .../json/ApiAppUpdateRequestDefaultExample.json | 2 +- examples/json/ApiAppUpdateResponseExample.json | 4 ++-- examples/json/FaxLineDeleteRequestExample.json | 2 +- examples/json/FaxSendRequestExample.json | 4 ++-- ...raftCreateRequestFormFieldGroupsExample.json | 1 + ...DraftCreateRequestFormFieldRulesExample.json | 1 + ...eateRequestFormFieldsPerDocumentExample.json | 1 + openapi-raw.yaml | 17 +++++++++++++++++ openapi-sdk.yaml | 17 +++++++++++++++++ openapi.yaml | 17 +++++++++++++++++ .../Dropbox.SignSandbox.csproj | 2 +- sdks/node/docs/api/ApiAppApi.md | 2 +- sdks/php/docs/Api/ApiAppApi.md | 2 +- sdks/python/docs/ApiAppApi.md | 2 +- sdks/python/dropbox_sign/__init__.py | 12 ++++++------ sdks/python/dropbox_sign/api/account_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/api_app_api.py | 12 ++++++------ .../dropbox_sign/api/bulk_send_job_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/embedded_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/fax_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/fax_line_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/o_auth_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/report_api.py | 12 ++++++------ .../dropbox_sign/api/signature_request_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/team_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/template_api.py | 12 ++++++------ .../dropbox_sign/api/unclaimed_draft_api.py | 12 ++++++------ sdks/python/dropbox_sign/api_client.py | 12 ++++++------ sdks/python/dropbox_sign/configuration.py | 12 ++++++------ sdks/python/dropbox_sign/exceptions.py | 12 ++++++------ sdks/python/dropbox_sign/models/__init__.py | 12 ++++++------ .../models/account_create_request.py | 12 ++++++------ .../models/account_create_response.py | 12 ++++++------ .../dropbox_sign/models/account_get_response.py | 12 ++++++------ .../dropbox_sign/models/account_response.py | 12 ++++++------ .../models/account_response_quotas.py | 12 ++++++------ .../models/account_response_usage.py | 12 ++++++------ .../models/account_update_request.py | 12 ++++++------ .../models/account_verify_request.py | 12 ++++++------ .../models/account_verify_response.py | 12 ++++++------ .../models/account_verify_response_account.py | 12 ++++++------ .../models/api_app_create_request.py | 12 ++++++------ .../dropbox_sign/models/api_app_get_response.py | 12 ++++++------ .../models/api_app_list_response.py | 12 ++++++------ .../dropbox_sign/models/api_app_response.py | 12 ++++++------ .../models/api_app_response_o_auth.py | 12 ++++++------ .../models/api_app_response_options.py | 12 ++++++------ .../models/api_app_response_owner_account.py | 12 ++++++------ .../api_app_response_white_labeling_options.py | 12 ++++++------ .../models/api_app_update_request.py | 12 ++++++------ .../models/bulk_send_job_get_response.py | 12 ++++++------ ..._send_job_get_response_signature_requests.py | 12 ++++++------ .../models/bulk_send_job_list_response.py | 12 ++++++------ .../models/bulk_send_job_response.py | 12 ++++++------ .../models/bulk_send_job_send_response.py | 12 ++++++------ .../models/embedded_edit_url_request.py | 12 ++++++------ .../models/embedded_edit_url_response.py | 12 ++++++------ .../embedded_edit_url_response_embedded.py | 12 ++++++------ .../models/embedded_sign_url_response.py | 12 ++++++------ .../embedded_sign_url_response_embedded.py | 12 ++++++------ .../dropbox_sign/models/error_response.py | 12 ++++++------ .../dropbox_sign/models/error_response_error.py | 12 ++++++------ .../models/event_callback_request.py | 12 ++++++------ .../models/event_callback_request_event.py | 12 ++++++------ .../event_callback_request_event_metadata.py | 12 ++++++------ .../dropbox_sign/models/fax_get_response.py | 12 ++++++------ .../models/fax_line_add_user_request.py | 12 ++++++------ .../fax_line_area_code_get_country_enum.py | 12 ++++++------ .../fax_line_area_code_get_province_enum.py | 12 ++++++------ .../models/fax_line_area_code_get_response.py | 12 ++++++------ .../models/fax_line_area_code_get_state_enum.py | 12 ++++++------ .../models/fax_line_create_request.py | 12 ++++++------ .../models/fax_line_delete_request.py | 12 ++++++------ .../models/fax_line_list_response.py | 12 ++++++------ .../models/fax_line_remove_user_request.py | 12 ++++++------ .../dropbox_sign/models/fax_line_response.py | 12 ++++++------ .../models/fax_line_response_fax_line.py | 12 ++++++------ .../dropbox_sign/models/fax_list_response.py | 12 ++++++------ sdks/python/dropbox_sign/models/fax_response.py | 12 ++++++------ .../models/fax_response_transmission.py | 12 ++++++------ .../dropbox_sign/models/fax_send_request.py | 12 ++++++------ .../python/dropbox_sign/models/file_response.py | 12 ++++++------ .../models/file_response_data_uri.py | 12 ++++++------ .../dropbox_sign/models/list_info_response.py | 12 ++++++------ .../models/o_auth_token_generate_request.py | 12 ++++++------ .../models/o_auth_token_refresh_request.py | 12 ++++++------ .../models/o_auth_token_response.py | 12 ++++++------ .../models/report_create_request.py | 12 ++++++------ .../models/report_create_response.py | 12 ++++++------ .../dropbox_sign/models/report_response.py | 12 ++++++------ ...ulk_create_embedded_with_template_request.py | 12 ++++++------ ...e_request_bulk_send_with_template_request.py | 12 ++++++------ ...signature_request_create_embedded_request.py | 12 ++++++------ ...est_create_embedded_with_template_request.py | 12 ++++++------ .../models/signature_request_get_response.py | 12 ++++++------ .../models/signature_request_list_response.py | 12 ++++++------ .../models/signature_request_remind_request.py | 12 ++++++------ .../models/signature_request_response.py | 12 ++++++------ .../signature_request_response_attachment.py | 12 ++++++------ ...nature_request_response_custom_field_base.py | 12 ++++++------ ...re_request_response_custom_field_checkbox.py | 12 ++++++------ ...nature_request_response_custom_field_text.py | 12 ++++++------ ...e_request_response_custom_field_type_enum.py | 12 ++++++------ .../signature_request_response_data_base.py | 12 ++++++------ ...signature_request_response_data_type_enum.py | 12 ++++++------ ...ture_request_response_data_value_checkbox.py | 12 ++++++------ ...equest_response_data_value_checkbox_merge.py | 12 ++++++------ ...e_request_response_data_value_date_signed.py | 12 ++++++------ ...ture_request_response_data_value_dropdown.py | 12 ++++++------ ...ture_request_response_data_value_initials.py | 12 ++++++------ ...gnature_request_response_data_value_radio.py | 12 ++++++------ ...ure_request_response_data_value_signature.py | 12 ++++++------ ...ignature_request_response_data_value_text.py | 12 ++++++------ ...re_request_response_data_value_text_merge.py | 12 ++++++------ .../signature_request_response_signatures.py | 12 ++++++------ .../models/signature_request_send_request.py | 12 ++++++------ ...nature_request_send_with_template_request.py | 12 ++++++------ .../models/signature_request_update_request.py | 12 ++++++------ .../dropbox_sign/models/sub_attachment.py | 12 ++++++------ .../dropbox_sign/models/sub_bulk_signer_list.py | 12 ++++++------ .../models/sub_bulk_signer_list_custom_field.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_cc.py | 12 ++++++------ .../dropbox_sign/models/sub_custom_field.py | 12 ++++++------ .../dropbox_sign/models/sub_editor_options.py | 12 ++++++------ .../dropbox_sign/models/sub_field_options.py | 12 ++++++------ .../dropbox_sign/models/sub_form_field_group.py | 12 ++++++------ .../dropbox_sign/models/sub_form_field_rule.py | 12 ++++++------ .../models/sub_form_field_rule_action.py | 12 ++++++------ .../models/sub_form_field_rule_trigger.py | 12 ++++++------ .../models/sub_form_fields_per_document_base.py | 12 ++++++------ .../sub_form_fields_per_document_checkbox.py | 12 ++++++------ ...b_form_fields_per_document_checkbox_merge.py | 12 ++++++------ .../sub_form_fields_per_document_date_signed.py | 12 ++++++------ .../sub_form_fields_per_document_dropdown.py | 12 ++++++------ .../sub_form_fields_per_document_font_enum.py | 12 ++++++------ .../sub_form_fields_per_document_hyperlink.py | 12 ++++++------ .../sub_form_fields_per_document_initials.py | 12 ++++++------ .../sub_form_fields_per_document_radio.py | 12 ++++++------ .../sub_form_fields_per_document_signature.py | 12 ++++++------ .../models/sub_form_fields_per_document_text.py | 12 ++++++------ .../sub_form_fields_per_document_text_merge.py | 12 ++++++------ .../sub_form_fields_per_document_type_enum.py | 12 ++++++------ .../dropbox_sign/models/sub_merge_field.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_o_auth.py | 12 ++++++------ sdks/python/dropbox_sign/models/sub_options.py | 12 ++++++------ .../sub_signature_request_grouped_signers.py | 12 ++++++------ .../models/sub_signature_request_signer.py | 12 ++++++------ .../sub_signature_request_template_signer.py | 12 ++++++------ .../dropbox_sign/models/sub_signing_options.py | 12 ++++++------ .../dropbox_sign/models/sub_team_response.py | 12 ++++++------ .../dropbox_sign/models/sub_template_role.py | 12 ++++++------ .../models/sub_unclaimed_draft_signer.py | 12 ++++++------ .../sub_unclaimed_draft_template_signer.py | 12 ++++++------ .../models/sub_white_labeling_options.py | 12 ++++++------ .../models/team_add_member_request.py | 12 ++++++------ .../dropbox_sign/models/team_create_request.py | 12 ++++++------ .../models/team_get_info_response.py | 12 ++++++------ .../dropbox_sign/models/team_get_response.py | 12 ++++++------ .../dropbox_sign/models/team_info_response.py | 12 ++++++------ .../dropbox_sign/models/team_invite_response.py | 12 ++++++------ .../models/team_invites_response.py | 12 ++++++------ .../dropbox_sign/models/team_member_response.py | 12 ++++++------ .../models/team_members_response.py | 12 ++++++------ .../dropbox_sign/models/team_parent_response.py | 12 ++++++------ .../models/team_remove_member_request.py | 12 ++++++------ .../python/dropbox_sign/models/team_response.py | 12 ++++++------ .../models/team_sub_teams_response.py | 12 ++++++------ .../dropbox_sign/models/team_update_request.py | 12 ++++++------ .../models/template_add_user_request.py | 12 ++++++------ .../template_create_embedded_draft_request.py | 12 ++++++------ .../template_create_embedded_draft_response.py | 12 ++++++------ ...e_create_embedded_draft_response_template.py | 12 ++++++------ .../models/template_create_request.py | 12 ++++++------ .../models/template_create_response.py | 12 ++++++------ .../models/template_create_response_template.py | 12 ++++++------ .../models/template_edit_response.py | 12 ++++++------ .../models/template_get_response.py | 12 ++++++------ .../models/template_list_response.py | 12 ++++++------ .../models/template_remove_user_request.py | 12 ++++++------ .../dropbox_sign/models/template_response.py | 12 ++++++------ .../models/template_response_account.py | 12 ++++++------ .../models/template_response_account_quota.py | 12 ++++++------ .../models/template_response_cc_role.py | 12 ++++++------ .../models/template_response_document.py | 12 ++++++------ ...plate_response_document_custom_field_base.py | 12 ++++++------ ...e_response_document_custom_field_checkbox.py | 12 ++++++------ ...plate_response_document_custom_field_text.py | 12 ++++++------ .../template_response_document_field_group.py | 12 ++++++------ ...mplate_response_document_field_group_rule.py | 12 ++++++------ ...emplate_response_document_form_field_base.py | 12 ++++++------ ...ate_response_document_form_field_checkbox.py | 12 ++++++------ ..._response_document_form_field_date_signed.py | 12 ++++++------ ...ate_response_document_form_field_dropdown.py | 12 ++++++------ ...te_response_document_form_field_hyperlink.py | 12 ++++++------ ...ate_response_document_form_field_initials.py | 12 ++++++------ ...mplate_response_document_form_field_radio.py | 12 ++++++------ ...te_response_document_form_field_signature.py | 12 ++++++------ ...emplate_response_document_form_field_text.py | 12 ++++++------ ...plate_response_document_static_field_base.py | 12 ++++++------ ...e_response_document_static_field_checkbox.py | 12 ++++++------ ...esponse_document_static_field_date_signed.py | 12 ++++++------ ...e_response_document_static_field_dropdown.py | 12 ++++++------ ..._response_document_static_field_hyperlink.py | 12 ++++++------ ...e_response_document_static_field_initials.py | 12 ++++++------ ...late_response_document_static_field_radio.py | 12 ++++++------ ..._response_document_static_field_signature.py | 12 ++++++------ ...plate_response_document_static_field_text.py | 12 ++++++------ .../template_response_field_avg_text_length.py | 12 ++++++------ .../models/template_response_signer_role.py | 12 ++++++------ .../models/template_update_files_request.py | 12 ++++++------ .../models/template_update_files_response.py | 12 ++++++------ .../template_update_files_response_template.py | 12 ++++++------ .../unclaimed_draft_create_embedded_request.py | 12 ++++++------ ...aft_create_embedded_with_template_request.py | 12 ++++++------ .../models/unclaimed_draft_create_request.py | 12 ++++++------ .../models/unclaimed_draft_create_response.py | 12 ++++++------ .../unclaimed_draft_edit_and_resend_request.py | 12 ++++++------ .../models/unclaimed_draft_response.py | 12 ++++++------ .../dropbox_sign/models/warning_response.py | 12 ++++++------ sdks/python/dropbox_sign/rest.py | 12 ++++++------ sdks/ruby/docs/ApiAppApi.md | 2 +- 229 files changed, 1309 insertions(+), 1255 deletions(-) diff --git a/examples/ApiAppUpdate.php b/examples/ApiAppUpdate.php index 2e96f9e44..60520cccc 100644 --- a/examples/ApiAppUpdate.php +++ b/examples/ApiAppUpdate.php @@ -20,7 +20,7 @@ $data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); $data->setName("New Name") - ->setCallbackUrl("http://example.com/dropboxsign") + ->setCallbackUrl("https://example.com/dropboxsign") ->setWhiteLabelingOptions($whiteLabelingOptions) ->setCustomLogoFile($customLogoFile); diff --git a/examples/ApiAppUpdate.py b/examples/ApiAppUpdate.py index 97ea06561..38f812095 100644 --- a/examples/ApiAppUpdate.py +++ b/examples/ApiAppUpdate.py @@ -21,7 +21,7 @@ data = models.ApiAppUpdateRequest( name="New Name", - callback_url="http://example.com/dropboxsign", + callback_url="https://example.com/dropboxsign", white_labeling_options=white_labeling_options, custom_logo_file=custom_logo_file, ) diff --git a/examples/ApiAppUpdate.rb b/examples/ApiAppUpdate.rb index 44572cfb8..940f70c78 100644 --- a/examples/ApiAppUpdate.rb +++ b/examples/ApiAppUpdate.rb @@ -18,7 +18,7 @@ data = Dropbox::Sign::ApiAppUpdateRequest.new data.name = "New Name" -data.callback_url = "http://example.com/dropboxsign" +data.callback_url = "https://example.com/dropboxsign" data.white_labeling_options = white_labeling_options data.custom_logo_file = custom_logo_file diff --git a/examples/ApiAppUpdate.sh b/examples/ApiAppUpdate.sh index 99a6b5f40..f8e22a9c8 100644 --- a/examples/ApiAppUpdate.sh +++ b/examples/ApiAppUpdate.sh @@ -1,6 +1,6 @@ curl -X PUT 'https://api.hellosign.com/v3/api_app/{client_id}' \ -u 'YOUR_API_KEY:' \ -F 'name=New Name' \ - -F 'callback_url=http://example.com/dropboxsign' \ + -F 'callback_url=https://example.com/dropboxsign' \ -F 'white_labeling_options[primary_button_color]=#00b3e6' \ -F 'white_labeling_options[primary_button_text_color]=#ffffff' diff --git a/examples/ApiAppUpdate.ts b/examples/ApiAppUpdate.ts index fdbc25559..a53f3f1c0 100644 --- a/examples/ApiAppUpdate.ts +++ b/examples/ApiAppUpdate.ts @@ -16,7 +16,7 @@ const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { const data: DropboxSign.ApiAppUpdateRequest = { name: "New Name", - callbackUrl: "http://example.com/dropboxsign", + callbackUrl: "https://example.com/dropboxsign", customLogoFile: fs.createReadStream("CustomLogoFile.png"), whiteLabelingOptions, }; diff --git a/examples/json/ApiAppCreateResponseExample.json b/examples/json/ApiAppCreateResponseExample.json index 9e92dda05..9e81c9fc0 100644 --- a/examples/json/ApiAppCreateResponseExample.json +++ b/examples/json/ApiAppCreateResponseExample.json @@ -7,7 +7,7 @@ "is_approved": false, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/ApiAppGetResponseExample.json b/examples/json/ApiAppGetResponseExample.json index 6074e44ec..a060d5261 100644 --- a/examples/json/ApiAppGetResponseExample.json +++ b/examples/json/ApiAppGetResponseExample.json @@ -7,7 +7,7 @@ "is_approved": true, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/ApiAppListResponseExample.json b/examples/json/ApiAppListResponseExample.json index 3c358bff5..130766322 100644 --- a/examples/json/ApiAppListResponseExample.json +++ b/examples/json/ApiAppListResponseExample.json @@ -8,7 +8,7 @@ "is_approved": true, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/ApiAppUpdateRequestDefaultExample.json b/examples/json/ApiAppUpdateRequestDefaultExample.json index f7bffb683..7977b977e 100644 --- a/examples/json/ApiAppUpdateRequestDefaultExample.json +++ b/examples/json/ApiAppUpdateRequestDefaultExample.json @@ -1,6 +1,6 @@ { "name": "New Name", - "callback_url": "http://example.com/dropboxsign", + "callback_url": "https://example.com/dropboxsign", "white_labeling_options": { "primary_button_color": "#00b3e6", "primary_button_text_color": "#ffffff" diff --git a/examples/json/ApiAppUpdateResponseExample.json b/examples/json/ApiAppUpdateResponseExample.json index 75c789a12..8b53b27db 100644 --- a/examples/json/ApiAppUpdateResponseExample.json +++ b/examples/json/ApiAppUpdateResponseExample.json @@ -1,13 +1,13 @@ { "api_app": { - "callback_url": "http://example.com/dropboxsign", + "callback_url": "https://example.com/dropboxsign", "client_id": "0dd3b823a682527788c4e40cb7b6f7e9", "created_at": 1436232339, "domains": ["example.com"], "is_approved": false, "name": "New Name", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" diff --git a/examples/json/FaxLineDeleteRequestExample.json b/examples/json/FaxLineDeleteRequestExample.json index 4bc5f0b67..1ffef7fe5 100644 --- a/examples/json/FaxLineDeleteRequestExample.json +++ b/examples/json/FaxLineDeleteRequestExample.json @@ -1,3 +1,3 @@ { - "number": "[FAX_NUMBER]", + "number": "[FAX_NUMBER]" } diff --git a/examples/json/FaxSendRequestExample.json b/examples/json/FaxSendRequestExample.json index fe7e68820..4b4ac16b3 100644 --- a/examples/json/FaxSendRequestExample.json +++ b/examples/json/FaxSendRequestExample.json @@ -1,5 +1,5 @@ { - "file_url": [ + "file_urls": [ "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" ], "test_mode": "true", @@ -9,4 +9,4 @@ "cover_page_message": "I'm sending you a fax!", "cover_page_from": "Faxer Faxerson", "title": "This is what the fax is about!" -} \ No newline at end of file +} diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json index ac48565f0..d8e5db930 100644 --- a/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json +++ b/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json @@ -41,5 +41,6 @@ "requirement": "require_0-1" } ], + "type": "request_signature", "test_mode": false } diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json index c12700553..8b1fe7d85 100644 --- a/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json +++ b/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json @@ -51,5 +51,6 @@ ] } ], + "type": "request_signature", "test_mode": false } diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json index 6ba9c8837..4d9961c57 100644 --- a/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json +++ b/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json @@ -32,5 +32,6 @@ "page": 1 } ], + "type": "request_signature", "test_mode": false } diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 3523daada..64d635940 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -1820,6 +1820,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -2101,6 +2102,7 @@ paths: required: true schema: type: string + example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -7765,6 +7767,11 @@ components: - CA - US - UK + x-enum-varnames-override: + typescript-node: + - Ca + - Us + - Uk city: description: '_t__FaxLineCreate::CITY' type: string @@ -8612,6 +8619,16 @@ components: enum: - change-field-visibility - change-group-visibility + x-enum-varnames-override: + csharp: + - FieldVisibility + - GroupVisibility + php: + - TYPE_FIELD_VISIBILITY + - TYPE_GROUP_VISIBILITY + typescript-node: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index c2d51ea54..818930290 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1826,6 +1826,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -2107,6 +2108,7 @@ paths: required: true schema: type: string + example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -7859,6 +7861,11 @@ components: - CA - US - UK + x-enum-varnames-override: + typescript-node: + - Ca + - Us + - Uk city: description: City type: string @@ -8926,6 +8933,16 @@ components: enum: - change-field-visibility - change-group-visibility + x-enum-varnames-override: + csharp: + - FieldVisibility + - GroupVisibility + php: + - TYPE_FIELD_VISIBILITY + - TYPE_GROUP_VISIBILITY + typescript-node: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/openapi.yaml b/openapi.yaml index f6ae63aec..d0dbb629b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1826,6 +1826,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -2107,6 +2108,7 @@ paths: required: true schema: type: string + example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -7859,6 +7861,11 @@ components: - CA - US - UK + x-enum-varnames-override: + typescript-node: + - Ca + - Us + - Uk city: description: City type: string @@ -8904,6 +8911,16 @@ components: enum: - change-field-visibility - change-group-visibility + x-enum-varnames-override: + csharp: + - FieldVisibility + - GroupVisibility + php: + - TYPE_FIELD_VISIBILITY + - TYPE_GROUP_VISIBILITY + typescript-node: + - FieldVisibility + - GroupVisibility type: object SubFormFieldRuleTrigger: required: diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj index 00fa04608..1adb5f2bf 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj @@ -13,6 +13,6 @@ - + diff --git a/sdks/node/docs/api/ApiAppApi.md b/sdks/node/docs/api/ApiAppApi.md index 69d312b43..758e164fe 100644 --- a/sdks/node/docs/api/ApiAppApi.md +++ b/sdks/node/docs/api/ApiAppApi.md @@ -417,7 +417,7 @@ const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { const data: DropboxSign.ApiAppUpdateRequest = { name: "New Name", - callbackUrl: "http://example.com/dropboxsign", + callbackUrl: "https://example.com/dropboxsign", customLogoFile: fs.createReadStream("CustomLogoFile.png"), whiteLabelingOptions, }; diff --git a/sdks/php/docs/Api/ApiAppApi.md b/sdks/php/docs/Api/ApiAppApi.md index a591601b2..45604a821 100644 --- a/sdks/php/docs/Api/ApiAppApi.md +++ b/sdks/php/docs/Api/ApiAppApi.md @@ -312,7 +312,7 @@ $customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); $data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); $data->setName("New Name") - ->setCallbackUrl("http://example.com/dropboxsign") + ->setCallbackUrl("https://example.com/dropboxsign") ->setWhiteLabelingOptions($whiteLabelingOptions) ->setCustomLogoFile($customLogoFile); diff --git a/sdks/python/docs/ApiAppApi.md b/sdks/python/docs/ApiAppApi.md index 9b982da37..2300565fb 100644 --- a/sdks/python/docs/ApiAppApi.md +++ b/sdks/python/docs/ApiAppApi.md @@ -327,7 +327,7 @@ with ApiClient(configuration) as api_client: data = models.ApiAppUpdateRequest( name="New Name", - callback_url="http://example.com/dropboxsign", + callback_url="https://example.com/dropboxsign", white_labeling_options=white_labeling_options, custom_logo_file=custom_logo_file, ) diff --git a/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index 2192ae233..53deb8f21 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -3,15 +3,15 @@ # flake8: noqa """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/api/account_api.py b/sdks/python/dropbox_sign/api/account_api.py index b3e5ce952..e3ba0b042 100644 --- a/sdks/python/dropbox_sign/api/account_api.py +++ b/sdks/python/dropbox_sign/api/account_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/api_app_api.py b/sdks/python/dropbox_sign/api/api_app_api.py index 93752b164..b130ad383 100644 --- a/sdks/python/dropbox_sign/api/api_app_api.py +++ b/sdks/python/dropbox_sign/api/api_app_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/bulk_send_job_api.py b/sdks/python/dropbox_sign/api/bulk_send_job_api.py index e53401b86..71ee4ca1f 100644 --- a/sdks/python/dropbox_sign/api/bulk_send_job_api.py +++ b/sdks/python/dropbox_sign/api/bulk_send_job_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/embedded_api.py b/sdks/python/dropbox_sign/api/embedded_api.py index fcb839f34..240da1b8e 100644 --- a/sdks/python/dropbox_sign/api/embedded_api.py +++ b/sdks/python/dropbox_sign/api/embedded_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 695dd29c9..7d286fc97 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index e32d2b234..50b55d795 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index bedd1bfff..774f2049c 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/report_api.py b/sdks/python/dropbox_sign/api/report_api.py index a31ee01f5..56314a1eb 100644 --- a/sdks/python/dropbox_sign/api/report_api.py +++ b/sdks/python/dropbox_sign/api/report_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index f78d1a219..98f08aed8 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/team_api.py b/sdks/python/dropbox_sign/api/team_api.py index 142d890c8..cd2c24468 100644 --- a/sdks/python/dropbox_sign/api/team_api.py +++ b/sdks/python/dropbox_sign/api/team_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index 87be9f0fd..9ddb3130e 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py index 620a71e90..75be55e4e 100644 --- a/sdks/python/dropbox_sign/api/unclaimed_draft_api.py +++ b/sdks/python/dropbox_sign/api/unclaimed_draft_api.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 import warnings diff --git a/sdks/python/dropbox_sign/api_client.py b/sdks/python/dropbox_sign/api_client.py index 16e766078..1b2a6c711 100644 --- a/sdks/python/dropbox_sign/api_client.py +++ b/sdks/python/dropbox_sign/api_client.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/configuration.py b/sdks/python/dropbox_sign/configuration.py index 016c4e591..949829704 100644 --- a/sdks/python/dropbox_sign/configuration.py +++ b/sdks/python/dropbox_sign/configuration.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/exceptions.py b/sdks/python/dropbox_sign/exceptions.py index 43300ceac..d19f9220f 100644 --- a/sdks/python/dropbox_sign/exceptions.py +++ b/sdks/python/dropbox_sign/exceptions.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 from typing import Any, Optional diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 97af4020e..71b8e6f5b 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -2,15 +2,15 @@ # flake8: noqa """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_create_request.py b/sdks/python/dropbox_sign/models/account_create_request.py index eb0d37416..62282b274 100644 --- a/sdks/python/dropbox_sign/models/account_create_request.py +++ b/sdks/python/dropbox_sign/models/account_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_create_response.py b/sdks/python/dropbox_sign/models/account_create_response.py index c1788e0e7..b8ff5aed3 100644 --- a/sdks/python/dropbox_sign/models/account_create_response.py +++ b/sdks/python/dropbox_sign/models/account_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_get_response.py b/sdks/python/dropbox_sign/models/account_get_response.py index 1be99f48c..f40a2d677 100644 --- a/sdks/python/dropbox_sign/models/account_get_response.py +++ b/sdks/python/dropbox_sign/models/account_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 8af0a6fb5..bf6e202fb 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index a58444549..8c69e6bab 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 8efc7a64b..6065a2230 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_update_request.py b/sdks/python/dropbox_sign/models/account_update_request.py index 7b5c95ddf..5e0f577ec 100644 --- a/sdks/python/dropbox_sign/models/account_update_request.py +++ b/sdks/python/dropbox_sign/models/account_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_request.py b/sdks/python/dropbox_sign/models/account_verify_request.py index a3a95c352..77e307efe 100644 --- a/sdks/python/dropbox_sign/models/account_verify_request.py +++ b/sdks/python/dropbox_sign/models/account_verify_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_response.py b/sdks/python/dropbox_sign/models/account_verify_response.py index c5f1960be..1fc490f81 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response.py +++ b/sdks/python/dropbox_sign/models/account_verify_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/account_verify_response_account.py b/sdks/python/dropbox_sign/models/account_verify_response_account.py index 3724cd063..715d9cea0 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response_account.py +++ b/sdks/python/dropbox_sign/models/account_verify_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_create_request.py b/sdks/python/dropbox_sign/models/api_app_create_request.py index 4f7181b59..14af7b247 100644 --- a/sdks/python/dropbox_sign/models/api_app_create_request.py +++ b/sdks/python/dropbox_sign/models/api_app_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_get_response.py b/sdks/python/dropbox_sign/models/api_app_get_response.py index 5c03394e6..d9fe3f3f1 100644 --- a/sdks/python/dropbox_sign/models/api_app_get_response.py +++ b/sdks/python/dropbox_sign/models/api_app_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_list_response.py b/sdks/python/dropbox_sign/models/api_app_list_response.py index 748cc9365..f0272df9f 100644 --- a/sdks/python/dropbox_sign/models/api_app_list_response.py +++ b/sdks/python/dropbox_sign/models/api_app_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index a1f0bf157..42f1f87fd 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index 981f94d9f..eeeae66cf 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index 751daf0de..cf3ef4f42 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index c1ed456c8..7191f948a 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index 734022f90..18d77df90 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/api_app_update_request.py b/sdks/python/dropbox_sign/models/api_app_update_request.py index e3f2a1abc..c393ba062 100644 --- a/sdks/python/dropbox_sign/models/api_app_update_request.py +++ b/sdks/python/dropbox_sign/models/api_app_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py index 749ba54b1..ed8fbfcc0 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index de4b9a20a..e49e0a733 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py index 91d471ccc..5ec2b8c0d 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index 0812cb85d..75a8477e2 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py index e340ab831..60f57d13f 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py index 525dfa828..e727d14cf 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py index 6c8ecc37a..c35ee6362 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py index 3dfe4d2d2..be2f6d26c 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py index ca92cdc23..6bc86e865 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py index 6de5a5b8e..4777554c1 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/error_response.py b/sdks/python/dropbox_sign/models/error_response.py index f85c24767..64ee3a32c 100644 --- a/sdks/python/dropbox_sign/models/error_response.py +++ b/sdks/python/dropbox_sign/models/error_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/error_response_error.py b/sdks/python/dropbox_sign/models/error_response_error.py index 6577b27e7..244177c4d 100644 --- a/sdks/python/dropbox_sign/models/error_response_error.py +++ b/sdks/python/dropbox_sign/models/error_response_error.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request.py b/sdks/python/dropbox_sign/models/event_callback_request.py index 768983736..84b205a31 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request.py +++ b/sdks/python/dropbox_sign/models/event_callback_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event.py b/sdks/python/dropbox_sign/models/event_callback_request_event.py index 971fff98b..470f382fd 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py index 572abb509..c9ca17c7e 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_get_response.py b/sdks/python/dropbox_sign/models/fax_get_response.py index 8c2b2249f..15b1788bf 100644 --- a/sdks/python/dropbox_sign/models/fax_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py index aaa2b4763..e4f92da3a 100644 --- a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py index 62b87eb08..94df88562 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py index cbe1eea81..e7994f3f5 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py index ac8722d39..c0d098bfc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py index 51f9da013..8cfe5ad2e 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_create_request.py b/sdks/python/dropbox_sign/models/fax_line_create_request.py index 42e16de1a..459e36ee6 100644 --- a/sdks/python/dropbox_sign/models/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_delete_request.py b/sdks/python/dropbox_sign/models/fax_line_delete_request.py index 7f5ebe5e7..140112ffa 100644 --- a/sdks/python/dropbox_sign/models/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_delete_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_list_response.py b/sdks/python/dropbox_sign/models/fax_line_list_response.py index 099c3cc55..d646b66e8 100644 --- a/sdks/python/dropbox_sign/models/fax_line_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py index e36be3090..710dc10cb 100644 --- a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_response.py b/sdks/python/dropbox_sign/models/fax_line_response.py index a719bc9fa..4a4cd3578 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py index 7d89f44cc..9ebd7db5b 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_list_response.py b/sdks/python/dropbox_sign/models/fax_list_response.py index b62b406e1..97dd078e7 100644 --- a/sdks/python/dropbox_sign/models/fax_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_response.py b/sdks/python/dropbox_sign/models/fax_response.py index 976606e37..9a5ffce3d 100644 --- a/sdks/python/dropbox_sign/models/fax_response.py +++ b/sdks/python/dropbox_sign/models/fax_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_response_transmission.py b/sdks/python/dropbox_sign/models/fax_response_transmission.py index 28cf397a0..1b1dc6e87 100644 --- a/sdks/python/dropbox_sign/models/fax_response_transmission.py +++ b/sdks/python/dropbox_sign/models/fax_response_transmission.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py index 9fe6c54a3..a26c775de 100644 --- a/sdks/python/dropbox_sign/models/fax_send_request.py +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/file_response.py b/sdks/python/dropbox_sign/models/file_response.py index e0479e3d6..e08fe26b4 100644 --- a/sdks/python/dropbox_sign/models/file_response.py +++ b/sdks/python/dropbox_sign/models/file_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/file_response_data_uri.py b/sdks/python/dropbox_sign/models/file_response_data_uri.py index c7c2e403f..94613587d 100644 --- a/sdks/python/dropbox_sign/models/file_response_data_uri.py +++ b/sdks/python/dropbox_sign/models/file_response_data_uri.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/list_info_response.py b/sdks/python/dropbox_sign/models/list_info_response.py index b51627288..1f6cf2ad8 100644 --- a/sdks/python/dropbox_sign/models/list_info_response.py +++ b/sdks/python/dropbox_sign/models/list_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py index ff2aefb6b..7f17c50f5 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py index 573036386..02400c6a9 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_response.py b/sdks/python/dropbox_sign/models/o_auth_token_response.py index e42732a19..d9a1569c3 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_response.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_create_request.py b/sdks/python/dropbox_sign/models/report_create_request.py index 4bed0f940..d142b6d5b 100644 --- a/sdks/python/dropbox_sign/models/report_create_request.py +++ b/sdks/python/dropbox_sign/models/report_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_create_response.py b/sdks/python/dropbox_sign/models/report_create_response.py index 6fc7ec8e0..7143a93ea 100644 --- a/sdks/python/dropbox_sign/models/report_create_response.py +++ b/sdks/python/dropbox_sign/models/report_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/report_response.py b/sdks/python/dropbox_sign/models/report_response.py index 2ed765c4a..7a41b74fd 100644 --- a/sdks/python/dropbox_sign/models/report_response.py +++ b/sdks/python/dropbox_sign/models/report_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index a3250eb3c..23c253846 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index 6c122576b..c6b2b7032 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index 8912b4560..8733c885a 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 2c7d080d7..8bec42df4 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_get_response.py b/sdks/python/dropbox_sign/models/signature_request_get_response.py index 8a1c556f4..444d5beda 100644 --- a/sdks/python/dropbox_sign/models/signature_request_get_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_list_response.py b/sdks/python/dropbox_sign/models/signature_request_list_response.py index 02f8d7426..e5a08fdfa 100644 --- a/sdks/python/dropbox_sign/models/signature_request_list_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_remind_request.py b/sdks/python/dropbox_sign/models/signature_request_remind_request.py index 21483ce2a..32c150011 100644 --- a/sdks/python/dropbox_sign/models/signature_request_remind_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_remind_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response.py b/sdks/python/dropbox_sign/models/signature_request_response.py index e367012a3..a79c0aad1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py index a8f364ba7..5c5648510 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py index 03fd81e16..fd5117bd9 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py index 229a9f245..22f87e272 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py index b4605b54f..e6ea56624 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py index db67d6872..8f715aea2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py index 1e72f17e7..3999601fe 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py index edd8ac007..8c4d01dac 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py index 97dd0ebf9..5810aff16 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py index a48b3d07e..11c3618dc 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py index b06f89be6..9c9ae9cc5 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py index 94ea1c7f4..cdd8d423e 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py index f5a493c75..f3eae53bd 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py index 8b531ece2..cebf21665 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py index 86461b32a..349299559 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py index df76cb604..7fa2c6e71 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py index 15ffbb331..f32e60fec 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py index 0a964e5f8..70a26b495 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index 806a1def1..3618ed1c1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py index 9c4045a3e..53c7efe26 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/signature_request_update_request.py b/sdks/python/dropbox_sign/models/signature_request_update_request.py index 37c4e18b2..c0c45afb5 100644 --- a/sdks/python/dropbox_sign/models/signature_request_update_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_attachment.py b/sdks/python/dropbox_sign/models/sub_attachment.py index a0c288d3a..65aa53c45 100644 --- a/sdks/python/dropbox_sign/models/sub_attachment.py +++ b/sdks/python/dropbox_sign/models/sub_attachment.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py index d5d8edb45..e647cd8c1 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py index dbd925d79..aef9b0ed2 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_cc.py b/sdks/python/dropbox_sign/models/sub_cc.py index a0aa82906..5ea92108c 100644 --- a/sdks/python/dropbox_sign/models/sub_cc.py +++ b/sdks/python/dropbox_sign/models/sub_cc.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_custom_field.py b/sdks/python/dropbox_sign/models/sub_custom_field.py index aa837bcdc..3fe2bf546 100644 --- a/sdks/python/dropbox_sign/models/sub_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_custom_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_editor_options.py b/sdks/python/dropbox_sign/models/sub_editor_options.py index 7e4315cbe..f67cfcbbd 100644 --- a/sdks/python/dropbox_sign/models/sub_editor_options.py +++ b/sdks/python/dropbox_sign/models/sub_editor_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_field_options.py b/sdks/python/dropbox_sign/models/sub_field_options.py index bd4ca3aa1..95c6514f1 100644 --- a/sdks/python/dropbox_sign/models/sub_field_options.py +++ b/sdks/python/dropbox_sign/models/sub_field_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_group.py b/sdks/python/dropbox_sign/models/sub_form_field_group.py index 9a9964b90..51a96961f 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_group.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule.py b/sdks/python/dropbox_sign/models/sub_form_field_rule.py index 345122638..2ca3d4e11 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py index 2e8eedfae..0f5c2e2a2 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py index 124a9212c..03b534175 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py index 0f05fbeee..1d9a0dd51 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py index f1765d128..9a93b890f 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py index 157a66f5c..dc16dd79b 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py index 298b43a5a..17e0b8a69 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py index 331b61720..dfab88a88 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py index 5244ac297..8865fdc9e 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py index f8c9d0c54..c9fda0dc0 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py index 8962b4cee..a5d640cba 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py index 69407f506..b34e05863 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py index e900a7500..3c7a3cf18 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py index b7f473dd3..ff7c01f0d 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py index 318deab88..77ee57590 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py index e2ca1330f..e1d61ca05 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_merge_field.py b/sdks/python/dropbox_sign/models/sub_merge_field.py index dba544e80..1db7477c9 100644 --- a/sdks/python/dropbox_sign/models/sub_merge_field.py +++ b/sdks/python/dropbox_sign/models/sub_merge_field.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_o_auth.py b/sdks/python/dropbox_sign/models/sub_o_auth.py index 979d595aa..b0ec45aca 100644 --- a/sdks/python/dropbox_sign/models/sub_o_auth.py +++ b/sdks/python/dropbox_sign/models/sub_o_auth.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_options.py b/sdks/python/dropbox_sign/models/sub_options.py index bd4f00ae8..20d318b8b 100644 --- a/sdks/python/dropbox_sign/models/sub_options.py +++ b/sdks/python/dropbox_sign/models/sub_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py index 24671c921..5b4fbac5c 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py index ac567d564..495d43b21 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py index 44b6881d8..a0dbbb9b6 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_signing_options.py b/sdks/python/dropbox_sign/models/sub_signing_options.py index e6cd96000..1b5ebebc8 100644 --- a/sdks/python/dropbox_sign/models/sub_signing_options.py +++ b/sdks/python/dropbox_sign/models/sub_signing_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_team_response.py b/sdks/python/dropbox_sign/models/sub_team_response.py index 98e55e192..7477a0164 100644 --- a/sdks/python/dropbox_sign/models/sub_team_response.py +++ b/sdks/python/dropbox_sign/models/sub_team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_template_role.py b/sdks/python/dropbox_sign/models/sub_template_role.py index 187fa77f9..82c52f920 100644 --- a/sdks/python/dropbox_sign/models/sub_template_role.py +++ b/sdks/python/dropbox_sign/models/sub_template_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py index fcc70e385..e6eac58fb 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py index 2154537e8..60a5c21b1 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py index 218da2aea..5c85661d0 100644 --- a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_add_member_request.py b/sdks/python/dropbox_sign/models/team_add_member_request.py index 275ccf00f..08491820e 100644 --- a/sdks/python/dropbox_sign/models/team_add_member_request.py +++ b/sdks/python/dropbox_sign/models/team_add_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_create_request.py b/sdks/python/dropbox_sign/models/team_create_request.py index 0c0c696ad..bf97f938c 100644 --- a/sdks/python/dropbox_sign/models/team_create_request.py +++ b/sdks/python/dropbox_sign/models/team_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_get_info_response.py b/sdks/python/dropbox_sign/models/team_get_info_response.py index 3453baa20..e9d858a54 100644 --- a/sdks/python/dropbox_sign/models/team_get_info_response.py +++ b/sdks/python/dropbox_sign/models/team_get_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_get_response.py b/sdks/python/dropbox_sign/models/team_get_response.py index 65845b263..c6a4a122a 100644 --- a/sdks/python/dropbox_sign/models/team_get_response.py +++ b/sdks/python/dropbox_sign/models/team_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_info_response.py b/sdks/python/dropbox_sign/models/team_info_response.py index 4c6ae507f..233239b41 100644 --- a/sdks/python/dropbox_sign/models/team_info_response.py +++ b/sdks/python/dropbox_sign/models/team_info_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_invite_response.py b/sdks/python/dropbox_sign/models/team_invite_response.py index fbc7d130a..28dcae72e 100644 --- a/sdks/python/dropbox_sign/models/team_invite_response.py +++ b/sdks/python/dropbox_sign/models/team_invite_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_invites_response.py b/sdks/python/dropbox_sign/models/team_invites_response.py index aa448daff..a664ef227 100644 --- a/sdks/python/dropbox_sign/models/team_invites_response.py +++ b/sdks/python/dropbox_sign/models/team_invites_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_member_response.py b/sdks/python/dropbox_sign/models/team_member_response.py index 0930eaa85..467363a90 100644 --- a/sdks/python/dropbox_sign/models/team_member_response.py +++ b/sdks/python/dropbox_sign/models/team_member_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_members_response.py b/sdks/python/dropbox_sign/models/team_members_response.py index f150d6ef4..5ef8f105d 100644 --- a/sdks/python/dropbox_sign/models/team_members_response.py +++ b/sdks/python/dropbox_sign/models/team_members_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_parent_response.py b/sdks/python/dropbox_sign/models/team_parent_response.py index 633b10b61..14e9b971f 100644 --- a/sdks/python/dropbox_sign/models/team_parent_response.py +++ b/sdks/python/dropbox_sign/models/team_parent_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_remove_member_request.py b/sdks/python/dropbox_sign/models/team_remove_member_request.py index d21215dca..e4266772f 100644 --- a/sdks/python/dropbox_sign/models/team_remove_member_request.py +++ b/sdks/python/dropbox_sign/models/team_remove_member_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index 57bec3332..a1364ddd1 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_sub_teams_response.py b/sdks/python/dropbox_sign/models/team_sub_teams_response.py index 6d6b76c23..97c1fd5c1 100644 --- a/sdks/python/dropbox_sign/models/team_sub_teams_response.py +++ b/sdks/python/dropbox_sign/models/team_sub_teams_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/team_update_request.py b/sdks/python/dropbox_sign/models/team_update_request.py index e7bdb4307..4eef699dc 100644 --- a/sdks/python/dropbox_sign/models/team_update_request.py +++ b/sdks/python/dropbox_sign/models/team_update_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_add_user_request.py b/sdks/python/dropbox_sign/models/template_add_user_request.py index 34c4ed62d..a842890f4 100644 --- a/sdks/python/dropbox_sign/models/template_add_user_request.py +++ b/sdks/python/dropbox_sign/models/template_add_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index 983d872f7..de35b19eb 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py index 5e728e79d..d27401f86 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index be23c205a..604fbf0ef 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index fa6df563c..0f453b4b9 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_response.py b/sdks/python/dropbox_sign/models/template_create_response.py index a42054f3c..02102b69b 100644 --- a/sdks/python/dropbox_sign/models/template_create_response.py +++ b/sdks/python/dropbox_sign/models/template_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index e4f253ef0..281a196f8 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_edit_response.py b/sdks/python/dropbox_sign/models/template_edit_response.py index 05b99f4c3..cf1542494 100644 --- a/sdks/python/dropbox_sign/models/template_edit_response.py +++ b/sdks/python/dropbox_sign/models/template_edit_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_get_response.py b/sdks/python/dropbox_sign/models/template_get_response.py index a32292b4f..c9976881b 100644 --- a/sdks/python/dropbox_sign/models/template_get_response.py +++ b/sdks/python/dropbox_sign/models/template_get_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_list_response.py b/sdks/python/dropbox_sign/models/template_list_response.py index 5deebe214..a7c4f7c7d 100644 --- a/sdks/python/dropbox_sign/models/template_list_response.py +++ b/sdks/python/dropbox_sign/models/template_list_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_remove_user_request.py b/sdks/python/dropbox_sign/models/template_remove_user_request.py index 565c47e32..7c1eb4d8c 100644 --- a/sdks/python/dropbox_sign/models/template_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/template_remove_user_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 01f36b353..88bdb041e 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 71358ff84..09ddc2130 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index 6c03effe9..bcccd2d25 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 8c005227d..88cd630eb 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index 56e887bd0..27f7c9b7b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index a7d2fa60c..7a9e276ff 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 4edf644c2..62d20d94f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 760dd57a4..489a15d0c 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index 201bd139e..e8492546d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index e5ade9d4e..9409fac83 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index 62f6d5f5b..210bf9f3f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index 29c4ff1e8..5e6c23b99 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 9b466fa1c..60469a645 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index 65b253c5d..de5c1eb0a 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 90f0c1f25..5f0ad6384 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index bc8512b4f..03003ab26 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index 7e76f9e27..aa9126b61 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index 7e742cebe..166fe3330 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index c04d1b550..66322b76f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index 4c16302d2..8c6e26f01 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index ea1c2b787..2ebc79440 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index 3a9bf86e0..fe923c931 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index 8444e77d8..db70fb277 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index 43106f1b1..3618481e3 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index 884425354..9c4534c48 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index e0701f1cc..3d85ef946 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index dbd12110f..8e27c3c54 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index 7fe3d5925..26e309e90 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index b3b5d4aff..552b7a87e 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index aab8250c4..8f013c4a8 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_request.py b/sdks/python/dropbox_sign/models/template_update_files_request.py index e8d3f22cd..9aed90b10 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_request.py +++ b/sdks/python/dropbox_sign/models/template_update_files_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response.py b/sdks/python/dropbox_sign/models/template_update_files_response.py index d2c07763a..d8a4728dc 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index a8fb50fa3..ba5a06762 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 33b165023..353355121 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py index a09307d19..798121996 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 2833e239b..207649f9c 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py index 11ae0d902..334c47d70 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py index 4b84d1031..5461f8702 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py index 1cd950950..1678b95ea 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/models/warning_response.py b/sdks/python/dropbox_sign/models/warning_response.py index f5aa1277d..67a037a1b 100644 --- a/sdks/python/dropbox_sign/models/warning_response.py +++ b/sdks/python/dropbox_sign/models/warning_response.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/python/dropbox_sign/rest.py b/sdks/python/dropbox_sign/rest.py index b369c3fde..877df1cd8 100644 --- a/sdks/python/dropbox_sign/rest.py +++ b/sdks/python/dropbox_sign/rest.py @@ -1,15 +1,15 @@ # coding: utf-8 """ - Dropbox Sign API +Dropbox Sign API - Dropbox Sign v3 API +Dropbox Sign v3 API - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) - Do not edit the class manually. +Do not edit the class manually. """ # noqa: E501 diff --git a/sdks/ruby/docs/ApiAppApi.md b/sdks/ruby/docs/ApiAppApi.md index 4a3262639..b225cc8d1 100644 --- a/sdks/ruby/docs/ApiAppApi.md +++ b/sdks/ruby/docs/ApiAppApi.md @@ -347,7 +347,7 @@ custom_logo_file = File.new('./CustomLogoFile.png') data = Dropbox::Sign::ApiAppUpdateRequest.new data.name = "New Name" -data.callback_url = "http://example.com/dropboxsign" +data.callback_url = "https://example.com/dropboxsign" data.white_labeling_options = white_labeling_options data.custom_logo_file = custom_logo_file From d6c25cfaa570f99355f74781c3f94e25313eda56 Mon Sep 17 00:00:00 2001 From: Jen Young <165731018+jyoung-dbx@users.noreply.github.com> Date: Mon, 3 Feb 2025 12:28:50 -0800 Subject: [PATCH 04/16] Fax copy changes (#468) --- openapi-sdk.yaml | 84 +++++---- openapi.yaml | 84 +++++---- sdks/dotnet/docs/FaxApi.md | 14 +- sdks/dotnet/docs/FaxLineAddUserRequest.md | 2 +- sdks/dotnet/docs/FaxLineApi.md | 22 +-- sdks/dotnet/docs/FaxLineCreateRequest.md | 2 +- sdks/dotnet/docs/FaxLineDeleteRequest.md | 2 +- sdks/dotnet/docs/FaxLineRemoveUserRequest.md | 2 +- sdks/dotnet/docs/FaxSendRequest.md | 2 +- sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs | 112 +++++------ .../dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs | 176 +++++++++--------- .../Model/FaxLineAddUserRequest.cs | 6 +- .../Model/FaxLineCreateRequest.cs | 28 +-- .../Model/FaxLineDeleteRequest.cs | 6 +- .../Model/FaxLineRemoveUserRequest.cs | 18 +- .../src/Dropbox.Sign/Model/FaxSendRequest.cs | 30 +-- sdks/java-v1/docs/FaxApi.md | 14 +- sdks/java-v1/docs/FaxLineAddUserRequest.md | 2 +- sdks/java-v1/docs/FaxLineApi.md | 22 +-- sdks/java-v1/docs/FaxLineCreateRequest.md | 8 +- sdks/java-v1/docs/FaxLineDeleteRequest.md | 2 +- sdks/java-v1/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/java-v1/docs/FaxSendRequest.md | 10 +- .../java/com/dropbox/sign/api/FaxApi.java | 32 ++-- .../java/com/dropbox/sign/api/FaxLineApi.java | 52 +++--- .../sign/model/FaxLineAddUserRequest.java | 2 +- .../sign/model/FaxLineCreateRequest.java | 10 +- .../sign/model/FaxLineDeleteRequest.java | 2 +- .../sign/model/FaxLineRemoveUserRequest.java | 6 +- .../dropbox/sign/model/FaxSendRequest.java | 12 +- sdks/java-v2/docs/FaxApi.md | 14 +- sdks/java-v2/docs/FaxLineAddUserRequest.md | 2 +- sdks/java-v2/docs/FaxLineApi.md | 22 +-- sdks/java-v2/docs/FaxLineCreateRequest.md | 8 +- sdks/java-v2/docs/FaxLineDeleteRequest.md | 2 +- sdks/java-v2/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/java-v2/docs/FaxSendRequest.md | 10 +- .../java/com/dropbox/sign/api/FaxApi.java | 28 +-- .../java/com/dropbox/sign/api/FaxLineApi.java | 44 ++--- .../sign/model/FaxLineAddUserRequest.java | 2 +- .../sign/model/FaxLineCreateRequest.java | 10 +- .../sign/model/FaxLineDeleteRequest.java | 2 +- .../sign/model/FaxLineRemoveUserRequest.java | 6 +- .../dropbox/sign/model/FaxSendRequest.java | 10 +- sdks/node/api/faxApi.ts | 14 +- sdks/node/api/faxLineApi.ts | 22 +-- sdks/node/docs/api/FaxApi.md | 14 +- sdks/node/docs/api/FaxLineApi.md | 22 +-- sdks/node/docs/model/FaxLineAddUserRequest.md | 2 +- sdks/node/docs/model/FaxLineCreateRequest.md | 8 +- sdks/node/docs/model/FaxLineDeleteRequest.md | 2 +- .../docs/model/FaxLineRemoveUserRequest.md | 6 +- sdks/node/docs/model/FaxSendRequest.md | 10 +- sdks/node/model/faxLineAddUserRequest.ts | 2 +- sdks/node/model/faxLineCreateRequest.ts | 8 +- sdks/node/model/faxLineDeleteRequest.ts | 2 +- sdks/node/model/faxLineRemoveUserRequest.ts | 6 +- sdks/node/model/faxSendRequest.ts | 10 +- sdks/php/docs/Api/FaxApi.md | 14 +- sdks/php/docs/Api/FaxLineApi.md | 22 +-- sdks/php/docs/Model/FaxLineAddUserRequest.md | 2 +- sdks/php/docs/Model/FaxLineCreateRequest.md | 8 +- sdks/php/docs/Model/FaxLineDeleteRequest.md | 2 +- .../docs/Model/FaxLineRemoveUserRequest.md | 6 +- sdks/php/docs/Model/FaxSendRequest.md | 10 +- sdks/php/src/Api/FaxApi.php | 20 +- sdks/php/src/Api/FaxLineApi.php | 80 ++++---- sdks/php/src/Model/FaxLineAddUserRequest.php | 2 +- sdks/php/src/Model/FaxLineCreateRequest.php | 8 +- sdks/php/src/Model/FaxLineDeleteRequest.php | 2 +- .../src/Model/FaxLineRemoveUserRequest.php | 6 +- sdks/php/src/Model/FaxSendRequest.php | 10 +- sdks/python/docs/FaxApi.md | 14 +- sdks/python/docs/FaxLineAddUserRequest.md | 2 +- sdks/python/docs/FaxLineApi.md | 22 +-- sdks/python/docs/FaxLineCreateRequest.md | 8 +- sdks/python/docs/FaxLineDeleteRequest.md | 2 +- sdks/python/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/python/docs/FaxSendRequest.md | 10 +- sdks/python/dropbox_sign/api/fax_api.py | 66 ++++--- sdks/python/dropbox_sign/api/fax_line_api.py | 147 +++++++++------ .../models/fax_line_add_user_request.py | 2 +- .../models/fax_line_create_request.py | 11 +- .../models/fax_line_delete_request.py | 2 +- .../models/fax_line_remove_user_request.py | 8 +- .../dropbox_sign/models/fax_send_request.py | 14 +- sdks/ruby/docs/FaxApi.md | 14 +- sdks/ruby/docs/FaxLineAddUserRequest.md | 2 +- sdks/ruby/docs/FaxLineApi.md | 22 +-- sdks/ruby/docs/FaxLineCreateRequest.md | 8 +- sdks/ruby/docs/FaxLineDeleteRequest.md | 2 +- sdks/ruby/docs/FaxLineRemoveUserRequest.md | 6 +- sdks/ruby/docs/FaxSendRequest.md | 10 +- sdks/ruby/lib/dropbox-sign/api/fax_api.rb | 28 +-- .../ruby/lib/dropbox-sign/api/fax_line_api.rb | 44 ++--- .../models/fax_line_add_user_request.rb | 2 +- .../models/fax_line_create_request.rb | 8 +- .../models/fax_line_delete_request.rb | 2 +- .../models/fax_line_remove_user_request.rb | 6 +- .../dropbox-sign/models/fax_send_request.rb | 10 +- translations/en.yaml | 84 +++++---- 101 files changed, 953 insertions(+), 865 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 818930290..304c1c17f 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1414,7 +1414,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1510,12 +1510,12 @@ paths: 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.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1610,7 +1610,7 @@ paths: tags: - Fax summary: 'Download Fax Files' - description: 'Downloads fax files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1706,7 +1706,7 @@ paths: 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.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1812,13 +1812,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/province and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1830,7 +1830,7 @@ paths: - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1888,7 +1888,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1908,7 +1908,7 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: @@ -1992,13 +1992,13 @@ paths: x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2104,7 +2104,7 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string @@ -2192,7 +2192,7 @@ paths: x-meta: seo: title: 'Get Fax Line | 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 line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2305,7 +2305,7 @@ paths: - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2313,7 +2313,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2321,7 +2321,7 @@ paths: - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: @@ -2411,7 +2411,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2511,13 +2511,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2526,7 +2526,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2620,7 +2620,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2718,7 +2718,7 @@ paths: $ref: examples/FaxSend.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + 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: @@ -7759,7 +7759,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7852,10 +7852,10 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA @@ -7867,10 +7867,10 @@ components: - Us - Uk city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7879,7 +7879,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7887,14 +7887,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7903,7 +7903,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7911,13 +7913,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7926,11 +7934,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -13411,7 +13419,7 @@ components: value: $ref: examples/json/FaxLineListResponseExample.json FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + summary: 'Returns the properties and settings of multiple Faxes' value: $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: diff --git a/openapi.yaml b/openapi.yaml index d0dbb629b..7baa54892 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1414,7 +1414,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1510,12 +1510,12 @@ paths: 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.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1610,7 +1610,7 @@ paths: tags: - Fax summary: 'Download Fax Files' - description: 'Downloads fax files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1706,7 +1706,7 @@ paths: 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.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1812,13 +1812,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/province and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1830,7 +1830,7 @@ paths: - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1888,7 +1888,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1908,7 +1908,7 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: @@ -1992,13 +1992,13 @@ paths: x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2104,7 +2104,7 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string @@ -2192,7 +2192,7 @@ paths: x-meta: seo: title: 'Get Fax Line | 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 line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2305,7 +2305,7 @@ paths: - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2313,7 +2313,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2321,7 +2321,7 @@ paths: - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: @@ -2411,7 +2411,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2511,13 +2511,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2526,7 +2526,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2620,7 +2620,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2718,7 +2718,7 @@ paths: $ref: examples/FaxSend.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + 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: @@ -7759,7 +7759,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7852,10 +7852,10 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA @@ -7867,10 +7867,10 @@ components: - Us - Uk city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7879,7 +7879,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7887,14 +7887,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7903,7 +7903,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7911,13 +7913,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7926,11 +7934,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -13389,7 +13397,7 @@ components: value: $ref: examples/json/FaxLineListResponseExample.json FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + summary: 'Returns the properties and settings of multiple Faxes' value: $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md index 207d25611..4368c0732 100644 --- a/sdks/dotnet/docs/FaxApi.md +++ b/sdks/dotnet/docs/FaxApi.md @@ -16,7 +16,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example ```csharp @@ -102,7 +102,7 @@ void (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example ```csharp @@ -197,7 +197,7 @@ catch (ApiException e) Get Fax -Returns information about fax +Returns information about a Fax ### Example ```csharp @@ -289,7 +289,7 @@ catch (ApiException e) Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example ```csharp @@ -352,8 +352,8 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **page** | **int?** | Page | [optional] [default to 1] | -| **pageSize** | **int?** | Page size | [optional] [default to 20] | +| **page** | **int?** | Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **int?** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -383,7 +383,7 @@ catch (ApiException e) Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example ```csharp diff --git a/sdks/dotnet/docs/FaxLineAddUserRequest.md b/sdks/dotnet/docs/FaxLineAddUserRequest.md index f89c0deef..705c9d91d 100644 --- a/sdks/dotnet/docs/FaxLineAddUserRequest.md +++ b/sdks/dotnet/docs/FaxLineAddUserRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] +**Number** | **string** | The Fax Line number | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [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/sdks/dotnet/docs/FaxLineApi.md b/sdks/dotnet/docs/FaxLineApi.md index ea3109c8a..d914fb09b 100644 --- a/sdks/dotnet/docs/FaxLineApi.md +++ b/sdks/dotnet/docs/FaxLineApi.md @@ -113,7 +113,7 @@ catch (ApiException e) Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example ```csharp @@ -173,10 +173,10 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **country** | **string** | Filter area codes by country. | | -| **state** | **string?** | Filter area codes by state. | [optional] | -| **province** | **string?** | Filter area codes by province. | [optional] | -| **city** | **string?** | Filter area codes by city. | [optional] | +| **country** | **string** | Filter area codes by country | | +| **state** | **string?** | Filter area codes by state | [optional] | +| **province** | **string?** | Filter area codes by province | [optional] | +| **city** | **string?** | Filter area codes by city | [optional] | ### Return type @@ -206,7 +206,7 @@ catch (ApiException e) Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example ```csharp @@ -451,7 +451,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **number** | **string** | The Fax Line number. | | +| **number** | **string** | The Fax Line number | | ### Return type @@ -542,9 +542,9 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **accountId** | **string?** | Account ID | [optional] | -| **page** | **int?** | Page | [optional] [default to 1] | -| **pageSize** | **int?** | Page size | [optional] [default to 20] | -| **showTeamLines** | **bool?** | Show team lines | [optional] | +| **page** | **int?** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **int?** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **showTeamLines** | **bool?** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -574,7 +574,7 @@ catch (ApiException e) Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example ```csharp diff --git a/sdks/dotnet/docs/FaxLineCreateRequest.md b/sdks/dotnet/docs/FaxLineCreateRequest.md index 21d3ffc88..d8bf8c4d9 100644 --- a/sdks/dotnet/docs/FaxLineCreateRequest.md +++ b/sdks/dotnet/docs/FaxLineCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AreaCode** | **int** | Area code | **Country** | **string** | Country | **City** | **string** | City | [optional] **AccountId** | **string** | Account ID | [optional] +**AreaCode** | **int** | Area code of the new Fax Line | **Country** | **string** | Country of the area code | **City** | **string** | City of the area code | [optional] **AccountId** | **string** | Account ID of the account that will be assigned this new Fax Line | [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/sdks/dotnet/docs/FaxLineDeleteRequest.md b/sdks/dotnet/docs/FaxLineDeleteRequest.md index 673880d28..1d8885b58 100644 --- a/sdks/dotnet/docs/FaxLineDeleteRequest.md +++ b/sdks/dotnet/docs/FaxLineDeleteRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | +**Number** | **string** | The Fax Line number | [[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/sdks/dotnet/docs/FaxLineRemoveUserRequest.md b/sdks/dotnet/docs/FaxLineRemoveUserRequest.md index 0d73414a7..3be0e7bdb 100644 --- a/sdks/dotnet/docs/FaxLineRemoveUserRequest.md +++ b/sdks/dotnet/docs/FaxLineRemoveUserRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] +**Number** | **string** | The Fax Line number | **AccountId** | **string** | Account ID of the user to remove access | [optional] **EmailAddress** | **string** | Email address of the user to remove access | [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/sdks/dotnet/docs/FaxSendRequest.md b/sdks/dotnet/docs/FaxSendRequest.md index b02d7f0b8..371c7c062 100644 --- a/sdks/dotnet/docs/FaxSendRequest.md +++ b/sdks/dotnet/docs/FaxSendRequest.md @@ -4,7 +4,7 @@ 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] +**Recipient** | **string** | Recipient of the fax Can be a phone number in E.164 format or email address | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax cover page recipient information | [optional] **CoverPageFrom** | **string** | Fax cover page sender information | [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/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs index 5ff4251f5..096d3bf66 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -31,7 +31,7 @@ public interface IFaxApiSync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -43,7 +43,7 @@ public interface IFaxApiSync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -54,7 +54,7 @@ public interface IFaxApiSync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -66,7 +66,7 @@ public interface IFaxApiSync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -77,7 +77,7 @@ public interface IFaxApiSync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -89,7 +89,7 @@ public interface IFaxApiSync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -100,11 +100,11 @@ public interface IFaxApiSync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// FaxListResponse FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); @@ -113,11 +113,11 @@ public interface IFaxApiSync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// ApiResponse of FaxListResponse ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); @@ -125,7 +125,7 @@ public interface IFaxApiSync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -137,7 +137,7 @@ public interface IFaxApiSync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -157,7 +157,7 @@ public interface IFaxApiAsync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -170,7 +170,7 @@ public interface IFaxApiAsync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -182,7 +182,7 @@ public interface IFaxApiAsync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -195,7 +195,7 @@ public interface IFaxApiAsync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -207,7 +207,7 @@ public interface IFaxApiAsync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -220,7 +220,7 @@ public interface IFaxApiAsync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -232,11 +232,11 @@ public interface IFaxApiAsync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxListResponse @@ -246,11 +246,11 @@ public interface IFaxApiAsync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxListResponse) @@ -259,7 +259,7 @@ public interface IFaxApiAsync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -272,7 +272,7 @@ public interface IFaxApiAsync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -401,7 +401,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -413,7 +413,7 @@ public void FaxDelete(string faxId, int operationIndex = 0) } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -476,7 +476,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -489,7 +489,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -555,7 +555,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -568,7 +568,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -632,7 +632,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -646,7 +646,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -713,7 +713,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -726,7 +726,7 @@ public FaxGetResponse FaxGet(string faxId, int operationIndex = 0) } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -789,7 +789,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -803,7 +803,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -869,11 +869,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// FaxListResponse public FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) @@ -883,11 +883,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// ApiResponse of FaxListResponse public Dropbox.Sign.Client.ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) @@ -948,11 +948,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxListResponse @@ -963,11 +963,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxListResponse) @@ -1031,7 +1031,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1044,7 +1044,7 @@ public FaxGetResponse FaxSend(FaxSendRequest faxSendRequest, int operationIndex } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1115,7 +1115,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1129,7 +1129,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs index 38f303895..127f2e4d7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs @@ -54,13 +54,13 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// FaxLineAreaCodeGetResponse FaxLineAreaCodeGetResponse FaxLineAreaCodeGet(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0); @@ -69,13 +69,13 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// ApiResponse of FaxLineAreaCodeGetResponse ApiResponse FaxLineAreaCodeGetWithHttpInfo(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0); @@ -83,7 +83,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -95,7 +95,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -132,7 +132,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// FaxLineResponse FaxLineResponse FaxLineGet(string number, int operationIndex = 0); @@ -144,7 +144,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// ApiResponse of FaxLineResponse ApiResponse FaxLineGetWithHttpInfo(string number, int operationIndex = 0); @@ -156,9 +156,9 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// FaxLineListResponse FaxLineListResponse FaxLineList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0); @@ -171,9 +171,9 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// ApiResponse of FaxLineListResponse ApiResponse FaxLineListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0); @@ -181,7 +181,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -193,7 +193,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -238,13 +238,13 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineAreaCodeGetResponse @@ -254,13 +254,13 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineAreaCodeGetResponse) @@ -269,7 +269,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -282,7 +282,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -322,7 +322,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineResponse @@ -335,7 +335,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineResponse) @@ -348,9 +348,9 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineListResponse @@ -364,9 +364,9 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineListResponse) @@ -375,7 +375,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -388,7 +388,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -689,13 +689,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// FaxLineAreaCodeGetResponse public FaxLineAreaCodeGetResponse FaxLineAreaCodeGet(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0) @@ -705,13 +705,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// ApiResponse of FaxLineAreaCodeGetResponse public Dropbox.Sign.Client.ApiResponse FaxLineAreaCodeGetWithHttpInfo(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0) @@ -783,13 +783,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineAreaCodeGetResponse @@ -800,13 +800,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineAreaCodeGetResponse) @@ -881,7 +881,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -894,7 +894,7 @@ public FaxLineResponse FaxLineCreate(FaxLineCreateRequest faxLineCreateRequest, } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -965,7 +965,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -979,7 +979,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -1226,7 +1226,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineDeleteWithHttpInfo(FaxLine /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// FaxLineResponse public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) @@ -1239,7 +1239,7 @@ public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// ApiResponse of FaxLineResponse public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(string number, int operationIndex = 0) @@ -1302,7 +1302,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineResponse @@ -1316,7 +1316,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineResponse) @@ -1383,9 +1383,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// FaxLineListResponse public FaxLineListResponse FaxLineList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0) @@ -1399,9 +1399,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// ApiResponse of FaxLineListResponse public Dropbox.Sign.Client.ApiResponse FaxLineListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0) @@ -1474,9 +1474,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineListResponse @@ -1491,9 +1491,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineListResponse) @@ -1565,7 +1565,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1578,7 +1578,7 @@ public FaxLineResponse FaxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1649,7 +1649,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1663,7 +1663,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs index 55509a4bc..fbbc7084e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs @@ -41,7 +41,7 @@ protected FaxLineAddUserRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). + /// The Fax Line number (required). /// Account ID. /// Email address. public FaxLineAddUserRequest(string number = default(string), string accountId = default(string), string emailAddress = default(string)) @@ -74,9 +74,9 @@ public static FaxLineAddUserRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs index 733cab7f8..ad5c88445 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class FaxLineCreateRequest : IEquatable, IValidatableObject { /// - /// Country + /// Country of the area code /// - /// Country + /// Country of the area code [JsonConverter(typeof(StringEnumConverter))] public enum CountryEnum { @@ -61,9 +61,9 @@ public enum CountryEnum /// - /// Country + /// Country of the area code /// - /// Country + /// Country of the area code [DataMember(Name = "country", IsRequired = true, EmitDefaultValue = true)] public CountryEnum Country { get; set; } /// @@ -74,10 +74,10 @@ protected FaxLineCreateRequest() { } /// /// Initializes a new instance of the class. /// - /// Area code (required). - /// Country (required). - /// City. - /// Account ID. + /// Area code of the new Fax Line (required). + /// Country of the area code (required). + /// City of the area code. + /// Account ID of the account that will be assigned this new Fax Line. public FaxLineCreateRequest(int areaCode = default(int), CountryEnum country = default(CountryEnum), string city = default(string), string accountId = default(string)) { @@ -104,23 +104,23 @@ public static FaxLineCreateRequest Init(string jsonData) } /// - /// Area code + /// Area code of the new Fax Line /// - /// Area code + /// Area code of the new Fax Line [DataMember(Name = "area_code", IsRequired = true, EmitDefaultValue = true)] public int AreaCode { get; set; } /// - /// City + /// City of the area code /// - /// City + /// City of the area code [DataMember(Name = "city", EmitDefaultValue = true)] public string City { get; set; } /// - /// Account ID + /// Account ID of the account that will be assigned this new Fax Line /// - /// Account ID + /// Account ID of the account that will be assigned this new Fax Line /// ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs index cb5a27378..5bc3e961d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs @@ -41,7 +41,7 @@ protected FaxLineDeleteRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). + /// The Fax Line number (required). public FaxLineDeleteRequest(string number = default(string)) { @@ -70,9 +70,9 @@ public static FaxLineDeleteRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs index eed6d36a9..1347d8250 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs @@ -41,9 +41,9 @@ protected FaxLineRemoveUserRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). - /// Account ID. - /// Email address. + /// The Fax Line number (required). + /// Account ID of the user to remove access. + /// Email address of the user to remove access. public FaxLineRemoveUserRequest(string number = default(string), string accountId = default(string), string emailAddress = default(string)) { @@ -74,24 +74,24 @@ public static FaxLineRemoveUserRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } /// - /// Account ID + /// Account ID of the user to remove access /// - /// Account ID + /// Account ID of the user to remove access /// ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// - /// Email address + /// Email address of the user to remove access /// - /// Email address + /// Email address of the user to remove access [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs index e4d42e6d4..d5eddb1b5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs @@ -41,13 +41,13 @@ protected FaxSendRequest() { } /// /// Initializes a new instance of the class. /// - /// Fax Send To Recipient (required). + /// Recipient of the fax Can be a phone number in E.164 format or email address (required). /// Fax Send From Sender (used only with fax number). - /// Fax File to Send. - /// Fax File URL to Send. + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.. /// API Test Mode Setting (default to false). - /// Fax Cover Page for Recipient. - /// Fax Cover Page for Sender. + /// Fax cover page recipient information. + /// Fax cover page sender information. /// Fax Cover Page Message. /// Fax Title. public FaxSendRequest(string recipient = default(string), string sender = default(string), List files = default(List), List fileUrls = default(List), bool testMode = false, string coverPageTo = default(string), string coverPageFrom = default(string), string coverPageMessage = default(string), string title = default(string)) @@ -86,9 +86,9 @@ public static FaxSendRequest Init(string jsonData) } /// - /// Fax Send To Recipient + /// Recipient of the fax Can be a phone number in E.164 format or email address /// - /// Fax Send To Recipient + /// Recipient of the fax Can be a phone number in E.164 format or email address /// recipient@example.com [DataMember(Name = "recipient", IsRequired = true, EmitDefaultValue = true)] public string Recipient { get; set; } @@ -102,16 +102,16 @@ public static FaxSendRequest Init(string jsonData) public string Sender { get; set; } /// - /// Fax File to Send + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. /// - /// Fax File to Send + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. [DataMember(Name = "files", EmitDefaultValue = true)] public List Files { get; set; } /// - /// Fax File URL to Send + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. /// - /// Fax File URL to Send + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. [DataMember(Name = "file_urls", EmitDefaultValue = true)] public List FileUrls { get; set; } @@ -123,17 +123,17 @@ public static FaxSendRequest Init(string jsonData) public bool TestMode { get; set; } /// - /// Fax Cover Page for Recipient + /// Fax cover page recipient information /// - /// Fax Cover Page for Recipient + /// Fax cover page recipient information /// Recipient Name [DataMember(Name = "cover_page_to", EmitDefaultValue = true)] public string CoverPageTo { get; set; } /// - /// Fax Cover Page for Sender + /// Fax cover page sender information /// - /// Fax Cover Page for Sender + /// Fax cover page sender information /// Sender Name [DataMember(Name = "cover_page_from", EmitDefaultValue = true)] public string CoverPageFrom { get; set; } diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md index 16102c5a4..5166ea29c 100644 --- a/sdks/java-v1/docs/FaxApi.md +++ b/sdks/java-v1/docs/FaxApi.md @@ -18,7 +18,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -84,7 +84,7 @@ null (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -153,7 +153,7 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -221,7 +221,7 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -262,8 +262,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,7 +291,7 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/java-v1/docs/FaxLineAddUserRequest.md b/sdks/java-v1/docs/FaxLineAddUserRequest.md index 1c9e997f9..4023bd024 100644 --- a/sdks/java-v1/docs/FaxLineAddUserRequest.md +++ b/sdks/java-v1/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/sdks/java-v1/docs/FaxLineApi.md b/sdks/java-v1/docs/FaxLineApi.md index 3aa4f8c4c..418bfc558 100644 --- a/sdks/java-v1/docs/FaxLineApi.md +++ b/sdks/java-v1/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -130,10 +130,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,7 +161,7 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -340,7 +340,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -408,9 +408,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,7 +438,7 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/java-v1/docs/FaxLineCreateRequest.md b/sdks/java-v1/docs/FaxLineCreateRequest.md index da9ba3953..7fd1be6bf 100644 --- a/sdks/java-v1/docs/FaxLineCreateRequest.md +++ b/sdks/java-v1/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/java-v1/docs/FaxLineDeleteRequest.md b/sdks/java-v1/docs/FaxLineDeleteRequest.md index de1748fa1..4b45b339f 100644 --- a/sdks/java-v1/docs/FaxLineDeleteRequest.md +++ b/sdks/java-v1/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/java-v1/docs/FaxLineRemoveUserRequest.md b/sdks/java-v1/docs/FaxLineRemoveUserRequest.md index 51d81b8fa..8e55d572d 100644 --- a/sdks/java-v1/docs/FaxLineRemoveUserRequest.md +++ b/sdks/java-v1/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/java-v1/docs/FaxSendRequest.md b/sdks/java-v1/docs/FaxSendRequest.md index 5b939a0af..65b105756 100644 --- a/sdks/java-v1/docs/FaxSendRequest.md +++ b/sdks/java-v1/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java index bf79b4f83..9e0041637 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -49,7 +49,7 @@ public void setApiClient(ApiClient apiClient) { } /** - * Delete Fax. Deletes the specified Fax from the system. + * Delete Fax. Deletes the specified Fax from the system * * @param faxId Fax ID (required) * @throws ApiException if fails to make API call @@ -65,7 +65,7 @@ public void faxDelete(String faxId) throws ApiException { } /** - * Delete Fax. Deletes the specified Fax from the system. + * Delete Fax. Deletes the specified Fax from the system * * @param faxId Fax ID (required) * @return ApiResponse<Void> @@ -113,7 +113,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** - * Download Fax Files. Downloads fax files + * Download Fax Files. Downloads files associated with a Fax * * @param faxId Fax ID (required) * @return File @@ -130,7 +130,7 @@ public File faxFiles(String faxId) throws ApiException { } /** - * Download Fax Files. Downloads fax files + * Download Fax Files. Downloads files associated with a Fax * * @param faxId Fax ID (required) * @return ApiResponse<File> @@ -180,7 +180,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException } /** - * Get Fax. Returns information about fax + * Get Fax. Returns information about a Fax * * @param faxId Fax ID (required) * @return FaxGetResponse @@ -197,7 +197,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { } /** - * Get Fax. Returns information about fax + * Get Fax. Returns information about a Fax * * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> @@ -246,10 +246,12 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx } /** - * Lists Faxes. Returns properties of multiple faxes + * Lists Faxes. Returns properties of multiple Faxes * - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * @param page Which page number of the Fax List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -302,10 +304,12 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api } /** - * Lists Faxes. Returns properties of multiple faxes + * Lists Faxes. Returns properties of multiple Faxes * - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * @param page Which page number of the Fax List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -354,7 +358,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa } /** - * Send Fax. Action to prepare and send a fax + * Send Fax. Creates and sends a new Fax with the submitted file(s) * * @param faxSendRequest (required) * @return FaxGetResponse @@ -371,7 +375,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException } /** - * Send Fax. Action to prepare and send a fax + * Send Fax. Creates and sends a new Fax with the submitted file(s) * * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 6f35fb7aa..e8736ad65 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -120,13 +120,13 @@ public ApiResponse faxLineAddUserWithHttpInfo( } /** - * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/province and city. + * Get Available Fax Line Area Codes. Returns a list of available area codes for a given + * state/province and city * - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -207,13 +207,13 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( } /** - * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/province and city. + * Get Available Fax Line Area Codes. Returns a list of available area codes for a given + * state/province and city * - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -266,7 +266,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( } /** - * Purchase Fax Line. Purchases a new Fax Line. + * Purchase Fax Line. Purchases a new Fax Line * * @param faxLineCreateRequest (required) * @return FaxLineResponse @@ -284,7 +284,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) } /** - * Purchase Fax Line. Purchases a new Fax Line. + * Purchase Fax Line. Purchases a new Fax Line * * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> @@ -401,7 +401,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line. Returns the properties and settings of a Fax Line. * - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call * @http.response.details @@ -418,7 +418,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line. Returns the properties and settings of a Fax Line. * - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -468,9 +468,11 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws * List Fax Lines. Returns the properties and settings of multiple Fax Lines. * * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -578,9 +580,11 @@ public ApiResponse faxLineListWithHttpInfo( * List Fax Lines. Returns the properties and settings of multiple Fax Lines. * * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -634,7 +638,7 @@ public ApiResponse faxLineListWithHttpInfo( } /** - * Remove Fax Line Access. Removes a user's access to the specified Fax Line. + * Remove Fax Line Access. Removes a user's access to the specified Fax Line * * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse @@ -652,7 +656,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU } /** - * Remove Fax Line Access. Removes a user's access to the specified Fax Line. + * Remove Fax Line Access. Removes a user's access to the specified Fax Line * * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index f1d852493..d86167c2e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -66,7 +66,7 @@ public FaxLineAddUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7f18d7bc7..e75ea0d36 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -40,7 +40,7 @@ public class FaxLineCreateRequest { public static final String JSON_PROPERTY_AREA_CODE = "area_code"; private Integer areaCode; - /** Country */ + /** Country of the area code */ public enum CountryEnum { CA("CA"), @@ -106,7 +106,7 @@ public FaxLineCreateRequest areaCode(Integer areaCode) { } /** - * Area code + * Area code of the new Fax Line * * @return areaCode */ @@ -129,7 +129,7 @@ public FaxLineCreateRequest country(CountryEnum country) { } /** - * Country + * Country of the area code * * @return country */ @@ -152,7 +152,7 @@ public FaxLineCreateRequest city(String city) { } /** - * City + * City of the area code * * @return city */ @@ -174,7 +174,7 @@ public FaxLineCreateRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * * @return accountId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index 7a7bfdd5f..efd21bff3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -55,7 +55,7 @@ public FaxLineDeleteRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 0347f5886..14d15e0bd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -67,7 +67,7 @@ public FaxLineRemoveUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ @@ -90,7 +90,7 @@ public FaxLineRemoveUserRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the user to remove access * * @return accountId */ @@ -112,7 +112,7 @@ public FaxLineRemoveUserRequest emailAddress(String emailAddress) { } /** - * Email address + * Email address of the user to remove access * * @return emailAddress */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index 571ba92f8..b668e9ff7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -92,7 +92,7 @@ public FaxSendRequest recipient(String recipient) { } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * * @return recipient */ @@ -145,7 +145,8 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either + * **files** or **file_urls[]**, but not both. * * @return files */ @@ -175,7 +176,8 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint + * requires either **files** or **file_urls[]**, but not both. * * @return fileUrls */ @@ -219,7 +221,7 @@ public FaxSendRequest coverPageTo(String coverPageTo) { } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * * @return coverPageTo */ @@ -241,7 +243,7 @@ public FaxSendRequest coverPageFrom(String coverPageFrom) { } /** - * Fax Cover Page for Sender + * Fax cover page sender information * * @return coverPageFrom */ diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md index 16102c5a4..5166ea29c 100644 --- a/sdks/java-v2/docs/FaxApi.md +++ b/sdks/java-v2/docs/FaxApi.md @@ -18,7 +18,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -84,7 +84,7 @@ null (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -153,7 +153,7 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -221,7 +221,7 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -262,8 +262,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,7 +291,7 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/java-v2/docs/FaxLineAddUserRequest.md b/sdks/java-v2/docs/FaxLineAddUserRequest.md index 1c9e997f9..4023bd024 100644 --- a/sdks/java-v2/docs/FaxLineAddUserRequest.md +++ b/sdks/java-v2/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/sdks/java-v2/docs/FaxLineApi.md b/sdks/java-v2/docs/FaxLineApi.md index 3aa4f8c4c..418bfc558 100644 --- a/sdks/java-v2/docs/FaxLineApi.md +++ b/sdks/java-v2/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -130,10 +130,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,7 +161,7 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -340,7 +340,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -408,9 +408,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,7 +438,7 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/java-v2/docs/FaxLineCreateRequest.md b/sdks/java-v2/docs/FaxLineCreateRequest.md index da9ba3953..7fd1be6bf 100644 --- a/sdks/java-v2/docs/FaxLineCreateRequest.md +++ b/sdks/java-v2/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/java-v2/docs/FaxLineDeleteRequest.md b/sdks/java-v2/docs/FaxLineDeleteRequest.md index de1748fa1..4b45b339f 100644 --- a/sdks/java-v2/docs/FaxLineDeleteRequest.md +++ b/sdks/java-v2/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/java-v2/docs/FaxLineRemoveUserRequest.md b/sdks/java-v2/docs/FaxLineRemoveUserRequest.md index 51d81b8fa..8e55d572d 100644 --- a/sdks/java-v2/docs/FaxLineRemoveUserRequest.md +++ b/sdks/java-v2/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/java-v2/docs/FaxSendRequest.md b/sdks/java-v2/docs/FaxSendRequest.md index 5b939a0af..65b105756 100644 --- a/sdks/java-v2/docs/FaxSendRequest.md +++ b/sdks/java-v2/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java index a42076f38..2bb22a100 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -52,7 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * Delete Fax. - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @throws ApiException if fails to make API call * @http.response.details @@ -69,7 +69,7 @@ public void faxDelete(String faxId) throws ApiException { /** * Delete Fax. - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -115,7 +115,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** * Download Fax Files. - * Downloads fax files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -133,7 +133,7 @@ public File faxFiles(String faxId) throws ApiException { /** * Download Fax Files. - * Downloads fax files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call @@ -180,7 +180,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException } /** * Get Fax. - * Returns information about fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -198,7 +198,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { /** * Get Fax. - * Returns information about fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call @@ -245,9 +245,9 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx } /** * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Returns properties of multiple Faxes + * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -303,9 +303,9 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api /** * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Returns properties of multiple Faxes + * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -354,7 +354,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa } /** * Send Fax. - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -372,7 +372,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException /** * Send Fax. - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java index c6d9a5eea..53d1a3bbc 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -116,11 +116,11 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq } /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/province and city. - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * Returns a list of available area codes for a given state/province and city + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -198,11 +198,11 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/province and city. - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * Returns a list of available area codes for a given state/province and city + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -252,7 +252,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St } /** * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -270,7 +270,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) /** * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -373,7 +373,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line. * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call * @http.response.details @@ -391,7 +391,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line. * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -440,9 +440,9 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws * List Fax Lines. * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -546,9 +546,9 @@ public ApiResponse faxLineListWithHttpInfo(String accountId * List Fax Lines. * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -599,7 +599,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId } /** * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -617,7 +617,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /** * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index 99f972a27..a4d24fbea 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -73,7 +73,7 @@ public FaxLineAddUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7d23eac13..c05bde435 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -45,7 +45,7 @@ public class FaxLineCreateRequest { private Integer areaCode; /** - * Country + * Country of the area code */ public enum CountryEnum { CA("CA"), @@ -114,7 +114,7 @@ public FaxLineCreateRequest areaCode(Integer areaCode) { } /** - * Area code + * Area code of the new Fax Line * @return areaCode */ @jakarta.annotation.Nonnull @@ -139,7 +139,7 @@ public FaxLineCreateRequest country(CountryEnum country) { } /** - * Country + * Country of the area code * @return country */ @jakarta.annotation.Nonnull @@ -164,7 +164,7 @@ public FaxLineCreateRequest city(String city) { } /** - * City + * City of the area code * @return city */ @jakarta.annotation.Nullable @@ -189,7 +189,7 @@ public FaxLineCreateRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * @return accountId */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index c7876dd3f..fb2e7beb5 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -65,7 +65,7 @@ public FaxLineDeleteRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 747853a52..8467a4004 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -73,7 +73,7 @@ public FaxLineRemoveUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull @@ -98,7 +98,7 @@ public FaxLineRemoveUserRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the user to remove access * @return accountId */ @jakarta.annotation.Nullable @@ -123,7 +123,7 @@ public FaxLineRemoveUserRequest emailAddress(String emailAddress) { } /** - * Email address + * Email address of the user to remove access * @return emailAddress */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index bb4a6e8a1..1830b7e87 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -100,7 +100,7 @@ public FaxSendRequest recipient(String recipient) { } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * @return recipient */ @jakarta.annotation.Nonnull @@ -158,7 +158,7 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return files */ @jakarta.annotation.Nullable @@ -191,7 +191,7 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return fileUrls */ @jakarta.annotation.Nullable @@ -241,7 +241,7 @@ public FaxSendRequest coverPageTo(String coverPageTo) { } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * @return coverPageTo */ @jakarta.annotation.Nullable @@ -266,7 +266,7 @@ public FaxSendRequest coverPageFrom(String coverPageFrom) { } /** - * Fax Cover Page for Sender + * Fax cover page sender information * @return coverPageFrom */ @jakarta.annotation.Nullable diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts index fdb7f9e9f..26e224280 100644 --- a/sdks/node/api/faxApi.ts +++ b/sdks/node/api/faxApi.ts @@ -119,7 +119,7 @@ export class FaxApi { } /** - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @summary Delete Fax * @param faxId Fax ID * @param options @@ -220,7 +220,7 @@ export class FaxApi { }); } /** - * Downloads fax files + * Downloads files associated with a Fax * @summary Download Fax Files * @param faxId Fax ID * @param options @@ -337,7 +337,7 @@ export class FaxApi { }); } /** - * Returns information about fax + * Returns information about a Fax * @summary Get Fax * @param faxId Fax ID * @param options @@ -454,10 +454,10 @@ export class FaxApi { }); } /** - * Returns properties of multiple faxes + * Returns properties of multiple Faxes * @summary Lists Faxes - * @param page Page - * @param pageSize Page size + * @param page Which page number of the Fax List to return. Defaults to `1`. + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options */ public async faxList( @@ -575,7 +575,7 @@ export class FaxApi { }); } /** - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @summary Send Fax * @param faxSendRequest * @param options diff --git a/sdks/node/api/faxLineApi.ts b/sdks/node/api/faxLineApi.ts index e9ca6c40d..24510ee88 100644 --- a/sdks/node/api/faxLineApi.ts +++ b/sdks/node/api/faxLineApi.ts @@ -261,12 +261,12 @@ export class FaxLineApi { }); } /** - * Returns a response with the area codes available for a given state/province and city. + * Returns a list of available area codes for a given state/province and city * @summary Get Available Fax Line Area Codes - * @param country Filter area codes by country. - * @param state Filter area codes by state. - * @param province Filter area codes by province. - * @param city Filter area codes by city. + * @param country Filter area codes by country + * @param state Filter area codes by state + * @param province Filter area codes by province + * @param city Filter area codes by city * @param options */ public async faxLineAreaCodeGet( @@ -473,7 +473,7 @@ export class FaxLineApi { }); } /** - * Purchases a new Fax Line. + * Purchases a new Fax Line * @summary Purchase Fax Line * @param faxLineCreateRequest * @param options @@ -735,7 +735,7 @@ export class FaxLineApi { /** * Returns the properties and settings of a Fax Line. * @summary Get Fax Line - * @param number The Fax Line number. + * @param number The Fax Line number * @param options */ public async faxLineGet( @@ -855,9 +855,9 @@ export class FaxLineApi { * Returns the properties and settings of multiple Fax Lines. * @summary List Fax Lines * @param accountId Account ID - * @param page Page - * @param pageSize Page size - * @param showTeamLines Show team lines + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. + * @param showTeamLines Include Fax Lines belonging to team members in the list * @param options */ public async faxLineList( @@ -993,7 +993,7 @@ export class FaxLineApi { }); } /** - * Removes a user\'s access to the specified Fax Line. + * Removes a user\'s access to the specified Fax Line * @summary Remove Fax Line Access * @param faxLineRemoveUserRequest * @param options diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md index 775241da2..6a67c3316 100644 --- a/sdks/node/docs/api/FaxApi.md +++ b/sdks/node/docs/api/FaxApi.md @@ -19,7 +19,7 @@ faxDelete(faxId: string) Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### TypeScript Example @@ -90,7 +90,7 @@ faxFiles(faxId: string): Buffer Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### TypeScript Example @@ -169,7 +169,7 @@ faxGet(faxId: string): FaxGetResponse Get Fax -Returns information about fax +Returns information about a Fax ### TypeScript Example @@ -246,7 +246,7 @@ faxList(page: number, pageSize: number): FaxListResponse Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### TypeScript Example @@ -298,8 +298,8 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **number**| Page | [optional] [default to 1] | -| **pageSize** | **number**| Page size | [optional] [default to 20] | +| **page** | **number**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **number**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -326,7 +326,7 @@ faxSend(faxSendRequest: FaxSendRequest): FaxGetResponse Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### TypeScript Example diff --git a/sdks/node/docs/api/FaxLineApi.md b/sdks/node/docs/api/FaxLineApi.md index ab90dd93e..dc59add61 100644 --- a/sdks/node/docs/api/FaxLineApi.md +++ b/sdks/node/docs/api/FaxLineApi.md @@ -104,7 +104,7 @@ faxLineAreaCodeGet(country: 'CA' | 'US' | 'UK', state: 'AK' | 'AL' | 'AR' | 'AZ' Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### TypeScript Example @@ -150,10 +150,10 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **country** | **'CA' | 'US' | 'UK'**| Filter area codes by country. | | -| **state** | **'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'**| Filter area codes by state. | [optional] | -| **province** | **'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'**| Filter area codes by province. | [optional] | -| **city** | **string**| Filter area codes by city. | [optional] | +| **country** | **'CA' | 'US' | 'UK'**| Filter area codes by country | | +| **state** | **'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'**| Filter area codes by state | [optional] | +| **province** | **'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'**| Filter area codes by province | [optional] | +| **city** | **string**| Filter area codes by city | [optional] | ### Return type @@ -180,7 +180,7 @@ faxLineCreate(faxLineCreateRequest: FaxLineCreateRequest): FaxLineResponse Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### TypeScript Example @@ -388,7 +388,7 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **number** | **string**| The Fax Line number. | | +| **number** | **string**| The Fax Line number | | ### Return type @@ -462,9 +462,9 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **accountId** | **string**| Account ID | [optional] | -| **page** | **number**| Page | [optional] [default to 1] | -| **pageSize** | **number**| Page size | [optional] [default to 20] | -| **showTeamLines** | **boolean**| Show team lines | [optional] | +| **page** | **number**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **number**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **showTeamLines** | **boolean**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -491,7 +491,7 @@ faxLineRemoveUser(faxLineRemoveUserRequest: FaxLineRemoveUserRequest): FaxLineRe Remove Fax Line Access -Removes a user\'s access to the specified Fax Line. +Removes a user\'s access to the specified Fax Line ### TypeScript Example diff --git a/sdks/node/docs/model/FaxLineAddUserRequest.md b/sdks/node/docs/model/FaxLineAddUserRequest.md index df23c2cdb..0b687c0d8 100644 --- a/sdks/node/docs/model/FaxLineAddUserRequest.md +++ b/sdks/node/docs/model/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | | `accountId` | ```string``` | Account ID | | | `emailAddress` | ```string``` | Email address | | diff --git a/sdks/node/docs/model/FaxLineCreateRequest.md b/sdks/node/docs/model/FaxLineCreateRequest.md index ae70b5cb9..6087b8973 100644 --- a/sdks/node/docs/model/FaxLineCreateRequest.md +++ b/sdks/node/docs/model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `areaCode`*_required_ | ```number``` | Area code | | -| `country`*_required_ | ```string``` | Country | | -| `city` | ```string``` | City | | -| `accountId` | ```string``` | Account ID | | +| `areaCode`*_required_ | ```number``` | Area code of the new Fax Line | | +| `country`*_required_ | ```string``` | Country of the area code | | +| `city` | ```string``` | City of the area code | | +| `accountId` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxLineDeleteRequest.md b/sdks/node/docs/model/FaxLineDeleteRequest.md index a2112ed33..fed4ee118 100644 --- a/sdks/node/docs/model/FaxLineDeleteRequest.md +++ b/sdks/node/docs/model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxLineRemoveUserRequest.md b/sdks/node/docs/model/FaxLineRemoveUserRequest.md index e161ecf38..9ae81a65e 100644 --- a/sdks/node/docs/model/FaxLineRemoveUserRequest.md +++ b/sdks/node/docs/model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `accountId` | ```string``` | Account ID | | -| `emailAddress` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `accountId` | ```string``` | Account ID of the user to remove access | | +| `emailAddress` | ```string``` | Email address of the user to remove access | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxSendRequest.md b/sdks/node/docs/model/FaxSendRequest.md index 72ebb6fb0..9df85d9d2 100644 --- a/sdks/node/docs/model/FaxSendRequest.md +++ b/sdks/node/docs/model/FaxSendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```string``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `fileUrls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```boolean``` | API Test Mode Setting | [default to false] | -| `coverPageTo` | ```string``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```string``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```string``` | Fax cover page recipient information | | +| `coverPageFrom` | ```string``` | Fax cover page sender information | | | `coverPageMessage` | ```string``` | Fax Cover Page Message | | | `title` | ```string``` | Fax Title | | diff --git a/sdks/node/model/faxLineAddUserRequest.ts b/sdks/node/model/faxLineAddUserRequest.ts index 95b75de1b..5f890f7dd 100644 --- a/sdks/node/model/faxLineAddUserRequest.ts +++ b/sdks/node/model/faxLineAddUserRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineAddUserRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; /** diff --git a/sdks/node/model/faxLineCreateRequest.ts b/sdks/node/model/faxLineCreateRequest.ts index 3a67d60e4..764da8214 100644 --- a/sdks/node/model/faxLineCreateRequest.ts +++ b/sdks/node/model/faxLineCreateRequest.ts @@ -26,19 +26,19 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineCreateRequest { /** - * Area code + * Area code of the new Fax Line */ "areaCode": number; /** - * Country + * Country of the area code */ "country": FaxLineCreateRequest.CountryEnum; /** - * City + * City of the area code */ "city"?: string; /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line */ "accountId"?: string; diff --git a/sdks/node/model/faxLineDeleteRequest.ts b/sdks/node/model/faxLineDeleteRequest.ts index 26d8798c4..1cb2e63dc 100644 --- a/sdks/node/model/faxLineDeleteRequest.ts +++ b/sdks/node/model/faxLineDeleteRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineDeleteRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; diff --git a/sdks/node/model/faxLineRemoveUserRequest.ts b/sdks/node/model/faxLineRemoveUserRequest.ts index 02f921c6a..26e8b4e6b 100644 --- a/sdks/node/model/faxLineRemoveUserRequest.ts +++ b/sdks/node/model/faxLineRemoveUserRequest.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineRemoveUserRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; /** - * Account ID + * Account ID of the user to remove access */ "accountId"?: string; /** - * Email address + * Email address of the user to remove access */ "emailAddress"?: string; diff --git a/sdks/node/model/faxSendRequest.ts b/sdks/node/model/faxSendRequest.ts index 11ee71ef4..fcd45d645 100644 --- a/sdks/node/model/faxSendRequest.ts +++ b/sdks/node/model/faxSendRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; export class FaxSendRequest { /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address */ "recipient": string; /** @@ -34,11 +34,11 @@ export class FaxSendRequest { */ "sender"?: string; /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. */ "files"?: Array; /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. */ "fileUrls"?: Array; /** @@ -46,11 +46,11 @@ export class FaxSendRequest { */ "testMode"?: boolean = false; /** - * Fax Cover Page for Recipient + * Fax cover page recipient information */ "coverPageTo"?: string; /** - * Fax Cover Page for Sender + * Fax cover page sender information */ "coverPageFrom"?: string; /** diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 78e411118..85450d672 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -18,7 +18,7 @@ faxDelete($fax_id) ``` Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -74,7 +74,7 @@ faxFiles($fax_id): \SplFileObject ``` Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -133,7 +133,7 @@ faxGet($fax_id): \Dropbox\Sign\Model\FaxGetResponse ``` Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -192,7 +192,7 @@ faxList($page, $page_size): \Dropbox\Sign\Model\FaxListResponse ``` Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -226,8 +226,8 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Page | [optional] [default to 1] | -| **page_size** | **int**| Page size | [optional] [default to 20] | +| **page** | **int**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -253,7 +253,7 @@ faxSend($fax_send_request): \Dropbox\Sign\Model\FaxGetResponse ``` Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index 44789fc33..eb8df874f 100644 --- a/sdks/php/docs/Api/FaxLineApi.md +++ b/sdks/php/docs/Api/FaxLineApi.md @@ -81,7 +81,7 @@ faxLineAreaCodeGet($country, $state, $province, $city): \Dropbox\Sign\Model\FaxL ``` Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -112,10 +112,10 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **country** | **string**| Filter area codes by country. | | -| **state** | **string**| Filter area codes by state. | [optional] | -| **province** | **string**| Filter area codes by province. | [optional] | -| **city** | **string**| Filter area codes by city. | [optional] | +| **country** | **string**| Filter area codes by country | | +| **state** | **string**| Filter area codes by state | [optional] | +| **province** | **string**| Filter area codes by province | [optional] | +| **city** | **string**| Filter area codes by city | [optional] | ### Return type @@ -141,7 +141,7 @@ faxLineCreate($fax_line_create_request): \Dropbox\Sign\Model\FaxLineResponse ``` Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -292,7 +292,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **number** | **string**| The Fax Line number. | | +| **number** | **string**| The Fax Line number | | ### Return type @@ -350,9 +350,9 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **account_id** | **string**| Account ID | [optional] | -| **page** | **int**| Page | [optional] [default to 1] | -| **page_size** | **int**| Page size | [optional] [default to 20] | -| **show_team_lines** | **bool**| Show team lines | [optional] | +| **page** | **int**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **show_team_lines** | **bool**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -378,7 +378,7 @@ faxLineRemoveUser($fax_line_remove_user_request): \Dropbox\Sign\Model\FaxLineRes ``` Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/php/docs/Model/FaxLineAddUserRequest.md b/sdks/php/docs/Model/FaxLineAddUserRequest.md index aef875b22..966ac619f 100644 --- a/sdks/php/docs/Model/FaxLineAddUserRequest.md +++ b/sdks/php/docs/Model/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | | `account_id` | ```string``` | Account ID | | | `email_address` | ```string``` | Email address | | diff --git a/sdks/php/docs/Model/FaxLineCreateRequest.md b/sdks/php/docs/Model/FaxLineCreateRequest.md index 6b599a339..3483d66d8 100644 --- a/sdks/php/docs/Model/FaxLineCreateRequest.md +++ b/sdks/php/docs/Model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```string``` | Country | | -| `city` | ```string``` | City | | -| `account_id` | ```string``` | Account ID | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```string``` | Country of the area code | | +| `city` | ```string``` | City of the area code | | +| `account_id` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineDeleteRequest.md b/sdks/php/docs/Model/FaxLineDeleteRequest.md index a2112ed33..fed4ee118 100644 --- a/sdks/php/docs/Model/FaxLineDeleteRequest.md +++ b/sdks/php/docs/Model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md index 6def01071..d5b79cefa 100644 --- a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md +++ b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `account_id` | ```string``` | Account ID | | -| `email_address` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `account_id` | ```string``` | Account ID of the user to remove access | | +| `email_address` | ```string``` | Email address of the user to remove access | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxSendRequest.md b/sdks/php/docs/Model/FaxSendRequest.md index dcbf730c4..432fd5ef6 100644 --- a/sdks/php/docs/Model/FaxSendRequest.md +++ b/sdks/php/docs/Model/FaxSendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```string``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```\SplFileObject[]``` | Fax File to Send | | -| `file_urls` | ```string[]``` | Fax File URL to Send | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```bool``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```string``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```string``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```string``` | Fax cover page recipient information | | +| `cover_page_from` | ```string``` | Fax cover page sender information | | | `cover_page_message` | ```string``` | Fax Cover Page Message | | | `title` | ```string``` | Fax Title | | diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index 619778c5b..2669fedbc 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -1043,8 +1043,8 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * * @return Model\FaxListResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1061,8 +1061,8 @@ public function faxList(int $page = 1, int $page_size = 20) * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return array of Model\FaxListResponse, HTTP status code, HTTP response headers (array of strings) @@ -1199,8 +1199,8 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1222,8 +1222,8 @@ function ($response) { * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1274,8 +1274,8 @@ function ($exception) { /** * Create request for operation 'faxList' * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return Request diff --git a/sdks/php/src/Api/FaxLineApi.php b/sdks/php/src/Api/FaxLineApi.php index 65cefff54..baeb810b1 100644 --- a/sdks/php/src/Api/FaxLineApi.php +++ b/sdks/php/src/Api/FaxLineApi.php @@ -486,10 +486,10 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * * @return Model\FaxLineAreaCodeGetResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -506,10 +506,10 @@ public function faxLineAreaCodeGet(string $country, string $state = null, string * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return array of Model\FaxLineAreaCodeGetResponse, HTTP status code, HTTP response headers (array of strings) @@ -646,10 +646,10 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -671,10 +671,10 @@ function ($response) { * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -725,10 +725,10 @@ function ($exception) { /** * Create request for operation 'faxLineAreaCodeGet' * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return Request @@ -1439,7 +1439,7 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * * @return Model\FaxLineResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1456,7 +1456,7 @@ public function faxLineGet(string $number) * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) @@ -1593,7 +1593,7 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1615,7 +1615,7 @@ function ($response) { * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1666,7 +1666,7 @@ function ($exception) { /** * Create request for operation 'faxLineGet' * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return Request @@ -1769,9 +1769,9 @@ public function faxLineGetRequest(string $number, string $contentType = self::co * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * * @return Model\FaxLineListResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1789,9 +1789,9 @@ public function faxLineList(string $account_id = null, int $page = 1, int $page_ * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return array of Model\FaxLineListResponse, HTTP status code, HTTP response headers (array of strings) @@ -1929,9 +1929,9 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1954,9 +1954,9 @@ function ($response) { * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -2008,9 +2008,9 @@ function ($exception) { * Create request for operation 'faxLineList' * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return Request diff --git a/sdks/php/src/Model/FaxLineAddUserRequest.php b/sdks/php/src/Model/FaxLineAddUserRequest.php index b7e2c849a..837f4885d 100644 --- a/sdks/php/src/Model/FaxLineAddUserRequest.php +++ b/sdks/php/src/Model/FaxLineAddUserRequest.php @@ -327,7 +327,7 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ diff --git a/sdks/php/src/Model/FaxLineCreateRequest.php b/sdks/php/src/Model/FaxLineCreateRequest.php index a898fef9d..5412325a0 100644 --- a/sdks/php/src/Model/FaxLineCreateRequest.php +++ b/sdks/php/src/Model/FaxLineCreateRequest.php @@ -364,7 +364,7 @@ public function getAreaCode() /** * Sets area_code * - * @param int $area_code Area code + * @param int $area_code Area code of the new Fax Line * * @return self */ @@ -391,7 +391,7 @@ public function getCountry() /** * Sets country * - * @param string $country Country + * @param string $country Country of the area code * * @return self */ @@ -428,7 +428,7 @@ public function getCity() /** * Sets city * - * @param string|null $city City + * @param string|null $city City of the area code * * @return self */ @@ -455,7 +455,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account ID + * @param string|null $account_id Account ID of the account that will be assigned this new Fax Line * * @return self */ diff --git a/sdks/php/src/Model/FaxLineDeleteRequest.php b/sdks/php/src/Model/FaxLineDeleteRequest.php index 1fc4fa4a6..9426ce2af 100644 --- a/sdks/php/src/Model/FaxLineDeleteRequest.php +++ b/sdks/php/src/Model/FaxLineDeleteRequest.php @@ -313,7 +313,7 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ diff --git a/sdks/php/src/Model/FaxLineRemoveUserRequest.php b/sdks/php/src/Model/FaxLineRemoveUserRequest.php index 5bec49060..560b147e7 100644 --- a/sdks/php/src/Model/FaxLineRemoveUserRequest.php +++ b/sdks/php/src/Model/FaxLineRemoveUserRequest.php @@ -327,7 +327,7 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ @@ -354,7 +354,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account ID + * @param string|null $account_id Account ID of the user to remove access * * @return self */ @@ -381,7 +381,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address Email address + * @param string|null $email_address Email address of the user to remove access * * @return self */ diff --git a/sdks/php/src/Model/FaxSendRequest.php b/sdks/php/src/Model/FaxSendRequest.php index d09573478..6124050b3 100644 --- a/sdks/php/src/Model/FaxSendRequest.php +++ b/sdks/php/src/Model/FaxSendRequest.php @@ -370,7 +370,7 @@ public function getRecipient() /** * Sets recipient * - * @param string $recipient Fax Send To Recipient + * @param string $recipient Recipient of the fax Can be a phone number in E.164 format or email address * * @return self */ @@ -424,7 +424,7 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Fax File to Send + * @param SplFileObject[]|null $files use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both * * @return self */ @@ -451,7 +451,7 @@ public function getFileUrls() /** * Sets file_urls * - * @param string[]|null $file_urls Fax File URL to Send + * @param string[]|null $file_urls use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both * * @return self */ @@ -505,7 +505,7 @@ public function getCoverPageTo() /** * Sets cover_page_to * - * @param string|null $cover_page_to Fax Cover Page for Recipient + * @param string|null $cover_page_to Fax cover page recipient information * * @return self */ @@ -532,7 +532,7 @@ public function getCoverPageFrom() /** * Sets cover_page_from * - * @param string|null $cover_page_from Fax Cover Page for Sender + * @param string|null $cover_page_from Fax cover page sender information * * @return self */ diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md index 93ec15305..44b5a5c87 100644 --- a/sdks/python/docs/FaxApi.md +++ b/sdks/python/docs/FaxApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -75,7 +75,7 @@ void (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -137,7 +137,7 @@ with ApiClient(configuration) as api_client: Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -199,7 +199,7 @@ with ApiClient(configuration) as api_client: Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -236,8 +236,8 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | +| `page` | **int** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -266,7 +266,7 @@ with ApiClient(configuration) as api_client: Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/python/docs/FaxLineAddUserRequest.md b/sdks/python/docs/FaxLineAddUserRequest.md index 9d2c5e199..ddc1053ff 100644 --- a/sdks/python/docs/FaxLineAddUserRequest.md +++ b/sdks/python/docs/FaxLineAddUserRequest.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | | `account_id` | ```str``` | Account ID | | | `email_address` | ```str``` | Email address | | diff --git a/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 0846b3384..288342e81 100644 --- a/sdks/python/docs/FaxLineApi.md +++ b/sdks/python/docs/FaxLineApi.md @@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client: Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -114,10 +114,10 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **str** | Filter area codes by country. | | -| `state` | **str** | Filter area codes by state. | [optional] | -| `province` | **str** | Filter area codes by province. | [optional] | -| `city` | **str** | Filter area codes by city. | [optional] | +| `country` | **str** | Filter area codes by country | | +| `state` | **str** | Filter area codes by state | [optional] | +| `province` | **str** | Filter area codes by province | [optional] | +| `city` | **str** | Filter area codes by city | [optional] | ### Return type @@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client: Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -305,7 +305,7 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **str** | The Fax Line number. | | +| `number` | **str** | The Fax Line number | | ### Return type @@ -366,9 +366,9 @@ with ApiClient(configuration) as api_client: | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Account ID | [optional] | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | -| `show_team_lines` | **bool** | Show team lines | [optional] | +| `page` | **int** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **bool** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -397,7 +397,7 @@ with ApiClient(configuration) as api_client: Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/python/docs/FaxLineCreateRequest.md b/sdks/python/docs/FaxLineCreateRequest.md index b6b33b3ac..0f53c117c 100644 --- a/sdks/python/docs/FaxLineCreateRequest.md +++ b/sdks/python/docs/FaxLineCreateRequest.md @@ -5,10 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```str``` | Country | | -| `city` | ```str``` | City | | -| `account_id` | ```str``` | Account ID | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```str``` | Country of the area code | | +| `city` | ```str``` | City of the area code | | +| `account_id` | ```str``` | Account ID of the account that will be assigned this new Fax Line | | [[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/sdks/python/docs/FaxLineDeleteRequest.md b/sdks/python/docs/FaxLineDeleteRequest.md index ad6985a8e..ad8c4dfe6 100644 --- a/sdks/python/docs/FaxLineDeleteRequest.md +++ b/sdks/python/docs/FaxLineDeleteRequest.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | [[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/sdks/python/docs/FaxLineRemoveUserRequest.md b/sdks/python/docs/FaxLineRemoveUserRequest.md index 561ddea6d..e2813a0ed 100644 --- a/sdks/python/docs/FaxLineRemoveUserRequest.md +++ b/sdks/python/docs/FaxLineRemoveUserRequest.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | -| `account_id` | ```str``` | Account ID | | -| `email_address` | ```str``` | Email address | | +| `number`*_required_ | ```str``` | The Fax Line number | | +| `account_id` | ```str``` | Account ID of the user to remove access | | +| `email_address` | ```str``` | Email address of the user to remove access | | [[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/sdks/python/docs/FaxSendRequest.md b/sdks/python/docs/FaxSendRequest.md index cdb4f49a0..50bed5b61 100644 --- a/sdks/python/docs/FaxSendRequest.md +++ b/sdks/python/docs/FaxSendRequest.md @@ -5,13 +5,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```str``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```str``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```str``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List[io.IOBase]``` | Fax File to Send | | -| `file_urls` | ```List[str]``` | Fax File URL to Send | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```bool``` | API Test Mode Setting | [default to False] | -| `cover_page_to` | ```str``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```str``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```str``` | Fax cover page recipient information | | +| `cover_page_from` | ```str``` | Fax cover page sender information | | | `cover_page_message` | ```str``` | Fax Cover Page Message | | | `title` | ```str``` | Fax Title | | diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 7d286fc97..4cf485a75 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -60,7 +60,7 @@ def fax_delete( ) -> None: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -125,7 +125,7 @@ def fax_delete_with_http_info( ) -> ApiResponse[None]: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -190,7 +190,7 @@ def fax_delete_without_preload_content( ) -> RESTResponseType: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -303,7 +303,7 @@ def fax_files( ) -> io.IOBase: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -368,7 +368,7 @@ def fax_files_with_http_info( ) -> ApiResponse[io.IOBase]: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -433,7 +433,7 @@ def fax_files_without_preload_content( ) -> RESTResponseType: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -546,7 +546,7 @@ def fax_get( ) -> FaxGetResponse: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -611,7 +611,7 @@ def fax_get_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -676,7 +676,7 @@ def fax_get_without_preload_content( ) -> RESTResponseType: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -776,11 +776,15 @@ def fax_list( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -796,11 +800,11 @@ def fax_list( ) -> FaxListResponse: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -851,11 +855,15 @@ def fax_list_with_http_info( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -871,11 +879,11 @@ def fax_list_with_http_info( ) -> ApiResponse[FaxListResponse]: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -926,11 +934,15 @@ def fax_list_without_preload_content( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -946,11 +958,11 @@ def fax_list_without_preload_content( ) -> RESTResponseType: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1069,7 +1081,7 @@ def fax_send( ) -> FaxGetResponse: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1134,7 +1146,7 @@ def fax_send_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1199,7 +1211,7 @@ def fax_send_without_preload_content( ) -> RESTResponseType: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index 50b55d795..b2949be41 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -327,16 +327,16 @@ def _fax_line_add_user_serialize( def fax_line_area_code_get( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -352,15 +352,15 @@ def fax_line_area_code_get( ) -> FaxLineAreaCodeGetResponse: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -412,16 +412,16 @@ def fax_line_area_code_get( def fax_line_area_code_get_with_http_info( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -437,15 +437,15 @@ def fax_line_area_code_get_with_http_info( ) -> ApiResponse[FaxLineAreaCodeGetResponse]: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -497,16 +497,16 @@ def fax_line_area_code_get_with_http_info( def fax_line_area_code_get_without_preload_content( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -522,15 +522,15 @@ def fax_line_area_code_get_without_preload_content( ) -> RESTResponseType: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -661,7 +661,7 @@ def fax_line_create( ) -> FaxLineResponse: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -726,7 +726,7 @@ def fax_line_create_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -791,7 +791,7 @@ def fax_line_create_without_preload_content( ) -> RESTResponseType: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -1196,7 +1196,7 @@ def _fax_line_delete_serialize( @validate_call def fax_line_get( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1213,7 +1213,7 @@ def fax_line_get( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1261,7 +1261,7 @@ def fax_line_get( @validate_call def fax_line_get_with_http_info( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1278,7 +1278,7 @@ def fax_line_get_with_http_info( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1326,7 +1326,7 @@ def fax_line_get_with_http_info( @validate_call def fax_line_get_without_preload_content( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1343,7 +1343,7 @@ def fax_line_get_without_preload_content( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1444,12 +1444,23 @@ def fax_line_list( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1469,11 +1480,11 @@ def fax_line_list( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1527,12 +1538,23 @@ def fax_line_list_with_http_info( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1552,11 +1574,11 @@ def fax_line_list_with_http_info( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1610,12 +1632,23 @@ def fax_line_list_without_preload_content( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1635,11 +1668,11 @@ def fax_line_list_without_preload_content( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1770,7 +1803,7 @@ def fax_line_remove_user( ) -> FaxLineResponse: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1835,7 +1868,7 @@ def fax_line_remove_user_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1900,7 +1933,7 @@ def fax_line_remove_user_without_preload_content( ) -> RESTResponseType: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest diff --git a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py index e4f92da3a..59ba5dbe9 100644 --- a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py @@ -32,7 +32,7 @@ class FaxLineAddUserRequest(BaseModel): FaxLineAddUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") account_id: Optional[StrictStr] = Field(default=None, description="Account ID") email_address: Optional[StrictStr] = Field( default=None, description="Email address" diff --git a/sdks/python/dropbox_sign/models/fax_line_create_request.py b/sdks/python/dropbox_sign/models/fax_line_create_request.py index 459e36ee6..3548180dc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_create_request.py @@ -32,10 +32,13 @@ class FaxLineCreateRequest(BaseModel): FaxLineCreateRequest """ # noqa: E501 - area_code: StrictInt = Field(description="Area code") - country: StrictStr = Field(description="Country") - city: Optional[StrictStr] = Field(default=None, description="City") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + area_code: StrictInt = Field(description="Area code of the new Fax Line") + country: StrictStr = Field(description="Country of the area code") + city: Optional[StrictStr] = Field(default=None, description="City of the area code") + account_id: Optional[StrictStr] = Field( + default=None, + description="Account ID of the account that will be assigned this new Fax Line", + ) __properties: ClassVar[List[str]] = ["area_code", "country", "city", "account_id"] @field_validator("country") diff --git a/sdks/python/dropbox_sign/models/fax_line_delete_request.py b/sdks/python/dropbox_sign/models/fax_line_delete_request.py index 140112ffa..b65b06f17 100644 --- a/sdks/python/dropbox_sign/models/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_delete_request.py @@ -32,7 +32,7 @@ class FaxLineDeleteRequest(BaseModel): FaxLineDeleteRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") __properties: ClassVar[List[str]] = ["number"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py index 710dc10cb..371178063 100644 --- a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py @@ -32,10 +32,12 @@ class FaxLineRemoveUserRequest(BaseModel): FaxLineRemoveUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + number: StrictStr = Field(description="The Fax Line number") + account_id: Optional[StrictStr] = Field( + default=None, description="Account ID of the user to remove access" + ) email_address: Optional[StrictStr] = Field( - default=None, description="Email address" + default=None, description="Email address of the user to remove access" ) __properties: ClassVar[List[str]] = ["number", "account_id", "email_address"] diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py index a26c775de..4b6428230 100644 --- a/sdks/python/dropbox_sign/models/fax_send_request.py +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -32,24 +32,28 @@ class FaxSendRequest(BaseModel): FaxSendRequest """ # noqa: E501 - recipient: StrictStr = Field(description="Fax Send To Recipient") + recipient: StrictStr = Field( + description="Recipient of the fax Can be a phone number in E.164 format or email address" + ) sender: Optional[StrictStr] = Field( default=None, description="Fax Send From Sender (used only with fax number)" ) files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( - default=None, description="Fax File to Send" + default=None, + description="Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) file_urls: Optional[List[StrictStr]] = Field( - default=None, description="Fax File URL to Send" + default=None, + description="Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) test_mode: Optional[StrictBool] = Field( default=False, description="API Test Mode Setting" ) cover_page_to: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Recipient" + default=None, description="Fax cover page recipient information" ) cover_page_from: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Sender" + default=None, description="Fax cover page sender information" ) cover_page_message: Optional[StrictStr] = Field( default=None, description="Fax Cover Page Message" diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md index a0e05a605..a260d58dc 100644 --- a/sdks/ruby/docs/FaxApi.md +++ b/sdks/ruby/docs/FaxApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Examples @@ -83,7 +83,7 @@ nil (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Examples @@ -152,7 +152,7 @@ end Get Fax -Returns information about fax +Returns information about a Fax ### Examples @@ -221,7 +221,7 @@ end Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Examples @@ -269,8 +269,8 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | +| `page` | **Integer** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -292,7 +292,7 @@ end Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Examples diff --git a/sdks/ruby/docs/FaxLineAddUserRequest.md b/sdks/ruby/docs/FaxLineAddUserRequest.md index 272d38367..f5339aea7 100644 --- a/sdks/ruby/docs/FaxLineAddUserRequest.md +++ b/sdks/ruby/docs/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `account_id` | ```String``` | Account ID | | | `email_address` | ```String``` | Email address | | diff --git a/sdks/ruby/docs/FaxLineApi.md b/sdks/ruby/docs/FaxLineApi.md index 49309267e..f7687b9e3 100644 --- a/sdks/ruby/docs/FaxLineApi.md +++ b/sdks/ruby/docs/FaxLineApi.md @@ -90,7 +90,7 @@ end Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/province and city. +Returns a list of available area codes for a given state/province and city ### Examples @@ -135,10 +135,10 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **String** | Filter area codes by country. | | -| `state` | **String** | Filter area codes by state. | [optional] | -| `province` | **String** | Filter area codes by province. | [optional] | -| `city` | **String** | Filter area codes by city. | [optional] | +| `country` | **String** | Filter area codes by country | | +| `state` | **String** | Filter area codes by state | [optional] | +| `province` | **String** | Filter area codes by province | [optional] | +| `city` | **String** | Filter area codes by city | [optional] | ### Return type @@ -160,7 +160,7 @@ end Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Examples @@ -345,7 +345,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **String** | The Fax Line number. | | +| `number` | **String** | The Fax Line number | | ### Return type @@ -413,9 +413,9 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **String** | Account ID | [optional] | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | -| `show_team_lines` | **Boolean** | Show team lines | [optional] | +| `page` | **Integer** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **Boolean** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -437,7 +437,7 @@ end Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Examples diff --git a/sdks/ruby/docs/FaxLineCreateRequest.md b/sdks/ruby/docs/FaxLineCreateRequest.md index bbe5312c6..5359e4073 100644 --- a/sdks/ruby/docs/FaxLineCreateRequest.md +++ b/sdks/ruby/docs/FaxLineCreateRequest.md @@ -6,8 +6,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `area_code`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | ```String``` | Country | | -| `city` | ```String``` | City | | -| `account_id` | ```String``` | Account ID | | +| `area_code`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | ```String``` | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `account_id` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/ruby/docs/FaxLineDeleteRequest.md b/sdks/ruby/docs/FaxLineDeleteRequest.md index 5c781f3b4..fc910e543 100644 --- a/sdks/ruby/docs/FaxLineDeleteRequest.md +++ b/sdks/ruby/docs/FaxLineDeleteRequest.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/ruby/docs/FaxLineRemoveUserRequest.md b/sdks/ruby/docs/FaxLineRemoveUserRequest.md index 98388f6f4..4156b6130 100644 --- a/sdks/ruby/docs/FaxLineRemoveUserRequest.md +++ b/sdks/ruby/docs/FaxLineRemoveUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `account_id` | ```String``` | Account ID | | -| `email_address` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `account_id` | ```String``` | Account ID of the user to remove access | | +| `email_address` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/ruby/docs/FaxSendRequest.md b/sdks/ruby/docs/FaxSendRequest.md index 6217af9f6..af96a2357 100644 --- a/sdks/ruby/docs/FaxSendRequest.md +++ b/sdks/ruby/docs/FaxSendRequest.md @@ -6,13 +6,13 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `file_urls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```String``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```String``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```String``` | Fax cover page recipient information | | +| `cover_page_from` | ```String``` | Fax cover page sender information | | | `cover_page_message` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index 2df3c1851..b6685eb60 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [nil] @@ -33,7 +33,7 @@ def fax_delete(fax_id, opts = {}) end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -90,7 +90,7 @@ def fax_delete_with_http_info(fax_id, opts = {}) end # Download Fax Files - # Downloads fax files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -100,7 +100,7 @@ def fax_files(fax_id, opts = {}) end # Download Fax Files - # Downloads fax files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers @@ -184,7 +184,7 @@ def fax_files_with_http_info(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -194,7 +194,7 @@ def fax_get(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers @@ -278,10 +278,10 @@ def fax_get_with_http_info(fax_id, opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [FaxListResponse] def fax_list(opts = {}) data, _status_code, _headers = fax_list_with_http_info(opts) @@ -289,10 +289,10 @@ def fax_list(opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [Array<(FaxListResponse, Integer, Hash)>] FaxListResponse data, response status code and response headers def fax_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -384,7 +384,7 @@ def fax_list_with_http_info(opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -394,7 +394,7 @@ def fax_send(fax_send_request, opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb index a0b9677db..986673dcf 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -132,12 +132,12 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/province and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes for a given state/province and city + # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters - # @option opts [String] :state Filter area codes by state. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [FaxLineAreaCodeGetResponse] def fax_line_area_code_get(country, opts = {}) data, _status_code, _headers = fax_line_area_code_get_with_http_info(country, opts) @@ -145,12 +145,12 @@ def fax_line_area_code_get(country, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/province and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes for a given state/province and city + # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters - # @option opts [String] :state Filter area codes by state. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [Array<(FaxLineAreaCodeGetResponse, Integer, Hash)>] FaxLineAreaCodeGetResponse data, response status code and response headers def fax_line_area_code_get_with_http_info(country, opts = {}) if @api_client.config.debugging @@ -249,7 +249,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -259,7 +259,7 @@ def fax_line_create(fax_line_create_request, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -441,7 +441,7 @@ def fax_line_delete_with_http_info(fax_line_delete_request, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [FaxLineResponse] def fax_line_get(number, opts = {}) @@ -451,7 +451,7 @@ def fax_line_get(number, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers def fax_line_get_with_http_info(number, opts = {}) @@ -538,9 +538,9 @@ def fax_line_get_with_http_info(number, opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [FaxLineListResponse] def fax_line_list(opts = {}) data, _status_code, _headers = fax_line_list_with_http_info(opts) @@ -551,9 +551,9 @@ def fax_line_list(opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [Array<(FaxLineListResponse, Integer, Hash)>] FaxLineListResponse data, response status code and response headers def fax_line_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -635,7 +635,7 @@ def fax_line_list_with_http_info(opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -645,7 +645,7 @@ def fax_line_remove_user(fax_line_remove_user_request, opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb index d2b04a378..37dec78c8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineAddUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb index 16f9ebdde..06b6b356a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb @@ -18,19 +18,19 @@ module Dropbox module Dropbox::Sign class FaxLineCreateRequest - # Area code + # Area code of the new Fax Line # @return [Integer] attr_accessor :area_code - # Country + # Country of the area code # @return [String] attr_accessor :country - # City + # City of the area code # @return [String] attr_accessor :city - # Account ID + # Account ID of the account that will be assigned this new Fax Line # @return [String] attr_accessor :account_id diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb index cdb344e44..a8fac5786 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineDeleteRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb index 3908c50fb..b6ed3e951 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class FaxLineRemoveUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number - # Account ID + # Account ID of the user to remove access # @return [String] attr_accessor :account_id - # Email address + # Email address of the user to remove access # @return [String] attr_accessor :email_address diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb index 18616cee1..098737b4e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxSendRequest - # Fax Send To Recipient + # Recipient of the fax Can be a phone number in E.164 format or email address # @return [String] attr_accessor :recipient @@ -26,11 +26,11 @@ class FaxSendRequest # @return [String] attr_accessor :sender - # Fax File to Send + # Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :files - # Fax File URL to Send + # Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :file_urls @@ -38,11 +38,11 @@ class FaxSendRequest # @return [Boolean] attr_accessor :test_mode - # Fax Cover Page for Recipient + # Fax cover page recipient information # @return [String] attr_accessor :cover_page_to - # Fax Cover Page for Sender + # Fax cover page sender information # @return [String] attr_accessor :cover_page_from diff --git a/translations/en.yaml b/translations/en.yaml index 52a9b3559..e6ee3186d 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -131,26 +131,34 @@ "EmbeddedSignUrl::SIGNATURE_ID": The id of the signature to get a signature url for. "FaxGet::SUMMARY": Get Fax -"FaxGet::DESCRIPTION": Returns information about fax +"FaxGet::DESCRIPTION": Returns information about a Fax "FaxParam::FAX_ID": Fax ID "FaxDelete::SUMMARY": Delete Fax -"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system. +"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system "FaxFiles::SUMMARY": Download Fax Files -"FaxFiles::DESCRIPTION": Downloads fax files +"FaxFiles::DESCRIPTION": Downloads files associated with a Fax "FaxList::SUMMARY": Lists Faxes -"FaxList::DESCRIPTION": Returns properties of multiple faxes -"FaxList::PAGE": Page -"FaxList::PAGE_SIZE": Page size +"FaxList::DESCRIPTION": Returns properties of multiple Faxes +"FaxList::PAGE": Which page number of the Fax List to return. Defaults to `1`. +"FaxList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. "FaxSend::SUMMARY": Send Fax -"FaxSend::DESCRIPTION": Action to prepare and send a fax -"FaxSend::RECIPIENT": Fax Send To Recipient +"FaxSend::DESCRIPTION": Creates and sends a new Fax with the submitted file(s) +"FaxSend::RECIPIENT": |- + Recipient of the fax + Can be a phone number in E.164 format or email address "FaxSend::SENDER": Fax Send From Sender (used only with fax number) -"FaxSend::FILE": Fax File to Send -"FaxSend::FILE_URL": Fax File URL to Send +"FaxSend::FILE": |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. +"FaxSend::FILE_URL": |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. "FaxSend::FILE_URL_NAMES": Fax File URL Names "FaxSend::TEST_MODE": API Test Mode Setting -"FaxSend::COVER_PAGE_TO": Fax Cover Page for Recipient -"FaxSend::COVER_PAGE_FROM": Fax Cover Page for Sender +"FaxSend::COVER_PAGE_TO": Fax cover page recipient information +"FaxSend::COVER_PAGE_FROM": Fax cover page sender information "FaxSend::COVER_PAGE_MESSAGE": Fax Cover Page Message "FaxSend::TITLE": Fax Title "FaxGetResponseExample::SUMMARY": Fax Response @@ -168,41 +176,41 @@ "Sub::FaxResponseTransmission::RECIPIENT": Fax Transmission Recipient "Sub::FaxResponseTransmission::STATUS_CODE": Fax Transmission Status Code "Sub::FaxResponseTransmission::SENT_AT": Fax Transmission Sent Timestamp -"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes. +"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes "FaxLineAddUser::SUMMARY": Add Fax Line User "FaxLineAddUser::DESCRIPTION": Grants a user access to the specified Fax Line. -"FaxLineAddUser::NUMBER": The Fax Line number. +"FaxLineAddUser::NUMBER": The Fax Line number "FaxLineAddUser::ACCOUNT_ID": Account ID "FaxLineAddUser::EMAIL_ADDRESS": Email address "FaxLineAreaCodeGet::SUMMARY": Get Available Fax Line Area Codes -"FaxLineAreaCodeGet::DESCRIPTION": Returns a response with the area codes available for a given state/province and city. -"FaxLineAreaCodeGet::CITY": Filter area codes by city. -"FaxLineAreaCodeGet::STATE": Filter area codes by state. -"FaxLineAreaCodeGet::PROVINCE": Filter area codes by province. -"FaxLineAreaCodeGet::COUNTRY": Filter area codes by country. +"FaxLineAreaCodeGet::DESCRIPTION": Returns a list of available area codes for a given state/province and city +"FaxLineAreaCodeGet::CITY": Filter area codes by city +"FaxLineAreaCodeGet::STATE": Filter area codes by state +"FaxLineAreaCodeGet::PROVINCE": Filter area codes by province +"FaxLineAreaCodeGet::COUNTRY": Filter area codes by country "FaxLineCreate::SUMMARY": Purchase Fax Line -"FaxLineCreate::DESCRIPTION": Purchases a new Fax Line. +"FaxLineCreate::DESCRIPTION": Purchases a new Fax Line "FaxLineDelete::SUMMARY": Delete Fax Line "FaxLineDelete::DESCRIPTION": Deletes the specified Fax Line from the subscription. "FaxLineGet::SUMMARY": Get Fax Line "FaxLineGet::DESCRIPTION": Returns the properties and settings of a Fax Line. -"FaxLineGet::NUMBER": The Fax Line number. +"FaxLineGet::NUMBER": The Fax Line number "FaxLineList::SUMMARY": List Fax Lines "FaxLineList::DESCRIPTION": Returns the properties and settings of multiple Fax Lines. "FaxLineList::ACCOUNT_ID": Account ID -"FaxLineList::PAGE": Page -"FaxLineList::PAGE_SIZE": Page size -"FaxLineList::SHOW_TEAM_LINES": Show team lines +"FaxLineList::PAGE": Which page number of the Fax Line List to return. Defaults to `1`. +"FaxLineList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. +"FaxLineList::SHOW_TEAM_LINES": Include Fax Lines belonging to team members in the list "FaxLineRemoveUser::SUMMARY": Remove Fax Line Access -"FaxLineRemoveUser::DESCRIPTION": Removes a user's access to the specified Fax Line. -"FaxLineRemoveUser::NUMBER": The Fax Line number. -"FaxLineRemoveUser::ACCOUNT_ID": Account ID -"FaxLineRemoveUser::EMAIL_ADDRESS": Email address -"FaxLineCreate::AREA_CODE": Area code -"FaxLineCreate::CITY": City -"FaxLineCreate::COUNTRY": Country -"FaxLineCreate::ACCOUNT_ID": Account ID -"FaxLineDelete::NUMBER": The Fax Line number. +"FaxLineRemoveUser::DESCRIPTION": Removes a user's access to the specified Fax Line +"FaxLineRemoveUser::NUMBER": The Fax Line number +"FaxLineRemoveUser::ACCOUNT_ID": Account ID of the user to remove access +"FaxLineRemoveUser::EMAIL_ADDRESS": Email address of the user to remove access +"FaxLineCreate::AREA_CODE": Area code of the new Fax Line +"FaxLineCreate::CITY": City of the area code +"FaxLineCreate::COUNTRY": Country of the area code +"FaxLineCreate::ACCOUNT_ID": Account ID of the account that will be assigned this new Fax Line +"FaxLineDelete::NUMBER": The Fax Line number "FaxLineResponseExample::SUMMARY": Sample Fax Line Response "FaxLineAreaCodeGetResponseExample::SUMMARY": Sample Area Code Response "FaxLineListResponseExample::SUMMARY": Sample Fax Line List Response @@ -1702,25 +1710,25 @@ "EmbeddedSignUrl::SEO::TITLE": "Get Embedded Sign URL | iFrame | Dropbox Sign for Developers" "EmbeddedSignUrl::SEO::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." "FaxGet::SEO::TITLE": "Get Fax | API Documentation | Dropbox Fax for Developers" -"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here." +"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here." "FaxDelete::SEO::TITLE": "Delete Fax | API Documentation | Dropbox Fax for Developers" "FaxDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here." "FaxFiles::SEO::TITLE": "Fax Files | API Documentation | Dropbox Fax for Developers" -"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here." +"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here." "FaxList::SEO::TITLE": "List Faxes | API Documentation | Dropbox Fax for Developers" "FaxList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here." -"FaxSend::SEO::TITLE": "Send Fax| API Documentation | Dropbox Fax for Developers" +"FaxSend::SEO::TITLE": "Send Fax | API Documentation | Dropbox Fax for Developers" "FaxSend::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here." "FaxLineAddUser::SEO::TITLE": "Fax Line Add User | API Documentation | Dropbox Fax for Developers" "FaxLineAddUser::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here." "FaxLineAreaCodeGet::SEO::TITLE": "Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers" -"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." +"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here." "FaxLineCreate::SEO::TITLE": "Purchase Fax Line | API Documentation | Dropbox Fax for Developers" "FaxLineCreate::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." "FaxLineDelete::SEO::TITLE": "Delete Fax Line | API Documentation | Dropbox Fax for Developers" "FaxLineDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here." "FaxLineGet::SEO::TITLE": "Get Fax Line | API Documentation | Dropbox Fax for Developers" -"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here." +"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here." "FaxLineList::SEO::TITLE": "List Fax Lines | API Documentation | Dropbox Fax for Developers" "FaxLineList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here." "FaxLineRemoveUser::SEO::TITLE": "Fax Line Remove User | API Documentation | Dropbox Fax for Developers" From 613cbd8e78d6a39e3f4bcef207e42e9d0d16907c Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 4 Feb 2025 12:29:26 -0600 Subject: [PATCH 05/16] Re-adding edit&resend endpoints (#467) --- ...uestEditEmbeddedRequestDefaultExample.json | 33 + ...tEmbeddedRequestGroupedSignersExample.json | 51 + ...ureRequestEditEmbeddedResponseExample.json | 52 + ...ddedWithTemplateRequestDefaultExample.json | 23 + ...itEmbeddedWithTemplateResponseExample.json | 45 + ...atureRequestEditRequestDefaultExample.json | 39 + ...questEditRequestGroupedSignersExample.json | 57 + .../SignatureRequestEditResponseExample.json | 76 + ...EditWithTemplateRequestDefaultExample.json | 36 + ...equestEditWithTemplateResponseExample.json | 46 + openapi-raw.yaml | 979 ++++- openapi-sdk.yaml | 3401 +++++++++++------ openapi.yaml | 511 ++- sdks/dotnet/README.md | 8 + sdks/dotnet/docs/SignatureRequestApi.md | 549 +++ .../SignatureRequestEditEmbeddedRequest.md | 10 + ...eRequestEditEmbeddedWithTemplateRequest.md | 10 + .../docs/SignatureRequestEditRequest.md | 10 + ...SignatureRequestEditWithTemplateRequest.md | 10 + .../Dropbox.Sign/Api/SignatureRequestApi.cs | 1016 +++++ .../SignatureRequestEditEmbeddedRequest.cs | 772 ++++ ...eRequestEditEmbeddedWithTemplateRequest.cs | 557 +++ .../Model/SignatureRequestEditRequest.cs | 793 ++++ ...SignatureRequestEditWithTemplateRequest.cs | 578 +++ sdks/java-v1/README.md | 8 + sdks/java-v1/docs/SignatureRequestApi.md | 440 +++ .../SignatureRequestEditEmbeddedRequest.md | 37 + ...eRequestEditEmbeddedWithTemplateRequest.md | 28 + .../docs/SignatureRequestEditRequest.md | 38 + ...SignatureRequestEditWithTemplateRequest.md | 29 + .../dropbox/sign/api/SignatureRequestApi.java | 395 ++ .../SignatureRequestEditEmbeddedRequest.java | 1471 +++++++ ...equestEditEmbeddedWithTemplateRequest.java | 958 +++++ .../model/SignatureRequestEditRequest.java | 1497 ++++++++ ...gnatureRequestEditWithTemplateRequest.java | 983 +++++ sdks/java-v2/README.md | 8 + sdks/java-v2/docs/SignatureRequestApi.md | 440 +++ .../SignatureRequestEditEmbeddedRequest.md | 37 + ...eRequestEditEmbeddedWithTemplateRequest.md | 28 + .../docs/SignatureRequestEditRequest.md | 38 + ...SignatureRequestEditWithTemplateRequest.md | 29 + .../dropbox/sign/api/SignatureRequestApi.java | 284 ++ .../SignatureRequestEditEmbeddedRequest.java | 1430 +++++++ ...equestEditEmbeddedWithTemplateRequest.java | 943 +++++ .../model/SignatureRequestEditRequest.java | 1480 +++++++ ...gnatureRequestEditWithTemplateRequest.java | 993 +++++ sdks/node/README.md | 8 + sdks/node/api/signatureRequestApi.ts | 652 ++++ sdks/node/dist/api.js | 1467 +++++-- sdks/node/docs/api/SignatureRequestApi.md | 683 ++++ .../SignatureRequestEditEmbeddedRequest.md | 34 + ...eRequestEditEmbeddedWithTemplateRequest.md | 25 + .../docs/model/SignatureRequestEditRequest.md | 35 + ...SignatureRequestEditWithTemplateRequest.md | 26 + sdks/node/model/index.ts | 14 + .../signatureRequestEditEmbeddedRequest.ts | 264 ++ ...eRequestEditEmbeddedWithTemplateRequest.ts | 181 + .../node/model/signatureRequestEditRequest.ts | 270 ++ ...signatureRequestEditWithTemplateRequest.ts | 193 + sdks/node/types/api/signatureRequestApi.d.ts | 6 +- sdks/node/types/model/index.d.ts | 6 +- .../signatureRequestEditEmbeddedRequest.d.ts | 42 + ...equestEditEmbeddedWithTemplateRequest.d.ts | 28 + .../model/signatureRequestEditRequest.d.ts | 43 + ...gnatureRequestEditWithTemplateRequest.d.ts | 29 + sdks/php/README.md | 8 + sdks/php/docs/Api/SignatureRequestApi.md | 384 ++ .../SignatureRequestEditEmbeddedRequest.md | 34 + ...eRequestEditEmbeddedWithTemplateRequest.md | 25 + .../docs/Model/SignatureRequestEditRequest.md | 35 + ...SignatureRequestEditWithTemplateRequest.md | 26 + sdks/php/src/Api/SignatureRequestApi.php | 1456 +++++++ .../SignatureRequestEditEmbeddedRequest.php | 1231 ++++++ ...RequestEditEmbeddedWithTemplateRequest.php | 924 +++++ .../src/Model/SignatureRequestEditRequest.php | 1262 ++++++ ...ignatureRequestEditWithTemplateRequest.php | 956 +++++ sdks/python/README.md | 8 + sdks/python/docs/SignatureRequestApi.md | 412 ++ .../SignatureRequestEditEmbeddedRequest.md | 34 + ...eRequestEditEmbeddedWithTemplateRequest.md | 25 + .../docs/SignatureRequestEditRequest.md | 35 + ...SignatureRequestEditWithTemplateRequest.md | 26 + sdks/python/dropbox_sign/__init__.py | 12 + .../dropbox_sign/api/signature_request_api.py | 1202 ++++++ sdks/python/dropbox_sign/models/__init__.py | 12 + ...signature_request_edit_embedded_request.py | 442 +++ ...est_edit_embedded_with_template_request.py | 288 ++ .../models/signature_request_edit_request.py | 446 +++ ...ture_request_edit_with_template_request.py | 290 ++ sdks/ruby/README.md | 8 + sdks/ruby/docs/SignatureRequestApi.md | 415 ++ .../SignatureRequestEditEmbeddedRequest.md | 33 + ...eRequestEditEmbeddedWithTemplateRequest.md | 24 + sdks/ruby/docs/SignatureRequestEditRequest.md | 34 + ...SignatureRequestEditWithTemplateRequest.md | 25 + sdks/ruby/lib/dropbox-sign.rb | 4 + .../dropbox-sign/api/signature_request_api.rb | 460 +++ ...signature_request_edit_embedded_request.rb | 588 +++ ...est_edit_embedded_with_template_request.rb | 485 +++ .../models/signature_request_edit_request.rb | 594 +++ ...ture_request_edit_with_template_request.rb | 492 +++ 101 files changed, 36511 insertions(+), 1486 deletions(-) create mode 100644 examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json create mode 100644 examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json create mode 100644 examples/json/SignatureRequestEditEmbeddedResponseExample.json create mode 100644 examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json create mode 100644 examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json create mode 100644 examples/json/SignatureRequestEditRequestDefaultExample.json create mode 100644 examples/json/SignatureRequestEditRequestGroupedSignersExample.json create mode 100644 examples/json/SignatureRequestEditResponseExample.json create mode 100644 examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json create mode 100644 examples/json/SignatureRequestEditWithTemplateResponseExample.json create mode 100644 sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/dotnet/docs/SignatureRequestEditRequest.md create mode 100644 sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs create mode 100644 sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/java-v1/docs/SignatureRequestEditRequest.md create mode 100644 sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java create mode 100644 sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/java-v2/docs/SignatureRequestEditRequest.md create mode 100644 sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java create mode 100644 sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/node/docs/model/SignatureRequestEditRequest.md create mode 100644 sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/node/model/signatureRequestEditEmbeddedRequest.ts create mode 100644 sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts create mode 100644 sdks/node/model/signatureRequestEditRequest.ts create mode 100644 sdks/node/model/signatureRequestEditWithTemplateRequest.ts create mode 100644 sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts create mode 100644 sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts create mode 100644 sdks/node/types/model/signatureRequestEditRequest.d.ts create mode 100644 sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts create mode 100644 sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/php/docs/Model/SignatureRequestEditRequest.md create mode 100644 sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php create mode 100644 sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php create mode 100644 sdks/php/src/Model/SignatureRequestEditRequest.php create mode 100644 sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php create mode 100644 sdks/python/docs/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/python/docs/SignatureRequestEditRequest.md create mode 100644 sdks/python/docs/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py create mode 100644 sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py create mode 100644 sdks/python/dropbox_sign/models/signature_request_edit_request.py create mode 100644 sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py create mode 100644 sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md create mode 100644 sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md create mode 100644 sdks/ruby/docs/SignatureRequestEditRequest.md create mode 100644 sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md create mode 100644 sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb diff --git a/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json b/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json new file mode 100644 index 000000000..724db5940 --- /dev/null +++ b/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json @@ -0,0 +1,33 @@ +{ + "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + }, + { + "email_address": "jill@example.com", + "name": "Jill", + "order": 1 + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "file_urls": [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + ], + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json b/examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json new file mode 100644 index 000000000..fb8cb1935 --- /dev/null +++ b/examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json @@ -0,0 +1,51 @@ +{ + "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "grouped_signers": [ + { + "group": "Group #1", + "order": 0, + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack" + }, + { + "email_address": "jill@example.com", + "name": "Jill" + } + ] + }, + { + "group": "Group #2", + "order": 1, + "signers": [ + { + "email_address": "bob@example.com", + "name": "Bob" + }, + { + "email_address": "charlie@example.com", + "name": "Charlie" + } + ] + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "file_urls": [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + ], + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditEmbeddedResponseExample.json b/examples/json/SignatureRequestEditEmbeddedResponseExample.json new file mode 100644 index 000000000..5def13bab --- /dev/null +++ b/examples/json/SignatureRequestEditEmbeddedResponseExample.json @@ -0,0 +1,52 @@ +{ + "signature_request": { + "signature_request_id": "a9f4825edef25f47e7b4c14ce8100d81d1693160", + "title": "NDA with Acme Co.", + "original_title": "The NDA we talked about", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + "metadata": {}, + "created_at": 1570471067, + "is_complete": false, + "is_declined": false, + "has_error": false, + "custom_fields": [], + "response_data": [], + "signing_url": null, + "signing_redirect_url": null, + "details_url": "https://app.hellosign.com/home/manage?guid=a9f4825edef25f47e7b4c14ce8100d81d1693160", + "requester_email_address": "me@dropboxsign.com", + "signatures": [ + { + "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3", + "signer_email_address": "jack@example.com", + "signer_name": "Jack", + "signer_role": null, + "order": 0, + "status_code": "awaiting_signature", + "signed_at": null, + "last_viewed_at": null, + "last_reminded_at": null, + "has_pin": false, + "has_sms_auth": false + }, + { + "signature_id": "616629ed37f8588d28600be17ab5d6b7", + "signer_email_address": "jill@example.com", + "signer_name": "Jill", + "signer_role": null, + "order": 1, + "status_code": "awaiting_signature", + "signed_at": null, + "last_viewed_at": null, + "last_reminded_at": null, + "has_pin": false, + "has_sms_auth": false + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ] + } +} diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json new file mode 100644 index 000000000..742998123 --- /dev/null +++ b/examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json @@ -0,0 +1,23 @@ +{ + "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + "template_ids": [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + ], + "subject": "Purchase Order", + "message": "Glad we could come to an agreement.", + "signers": [ + { + "role": "Client", + "name": "George", + "email_address": "george@example.com" + } + ], + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json new file mode 100644 index 000000000..3099142f2 --- /dev/null +++ b/examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json @@ -0,0 +1,45 @@ +{ + "signature_request": { + "signature_request_id": "17d163069282df5eb63857d31ff4a3bffa9e46c0", + "title": "Purchase Order", + "original_title": "Purchase Order", + "subject": "Purchase Order", + "metadata": {}, + "message": "Glad we could come to an agreement.", + "is_complete": false, + "is_declined": false, + "has_error": false, + "custom_fields": [ + { + "name": "Cost", + "value": "$20,000", + "type": "text", + "editor": "Client", + "required": true + } + ], + "response_data": [], + "signing_url": null, + "signing_redirect_url": null, + "details_url": "https://app.hellosign.com/home/manage?guid=17d163069282df5eb63857d31ff4a3bffa9e46c0", + "requester_email_address": "me@dropboxsign.com", + "signatures": [ + { + "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3", + "signer_email_address": "george@example.com", + "signer_name": "George", + "signer_role": "Client", + "order": null, + "status_code": "awaiting_signature", + "signed_at": null, + "last_viewed_at": null, + "last_reminded_at": null, + "has_pin": false, + "has_sms_auth": false + } + ], + "cc_email_addresses": [ + "accounting@dropboxsign.com" + ] + } +} diff --git a/examples/json/SignatureRequestEditRequestDefaultExample.json b/examples/json/SignatureRequestEditRequestDefaultExample.json new file mode 100644 index 000000000..adfda81ec --- /dev/null +++ b/examples/json/SignatureRequestEditRequestDefaultExample.json @@ -0,0 +1,39 @@ +{ + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + }, + { + "email_address": "jill@example.com", + "name": "Jill", + "order": 1 + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "file_urls": [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + ], + "metadata": { + "custom_id": 1234, + "custom_text": "NDA #9" + }, + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "field_options": { + "date_format": "DD - MM - YYYY" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditRequestGroupedSignersExample.json b/examples/json/SignatureRequestEditRequestGroupedSignersExample.json new file mode 100644 index 000000000..d78f99101 --- /dev/null +++ b/examples/json/SignatureRequestEditRequestGroupedSignersExample.json @@ -0,0 +1,57 @@ +{ + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "grouped_signers": [ + { + "group": "Group #1", + "order": 0, + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack" + }, + { + "email_address": "jill@example.com", + "name": "Jill" + } + ] + }, + { + "group": "Group #2", + "order": 1, + "signers": [ + { + "email_address": "bob@example.com", + "name": "Bob" + }, + { + "email_address": "charlie@example.com", + "name": "Charlie" + } + ] + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "file_urls": [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + ], + "metadata": { + "custom_id": 1234, + "custom_text": "NDA #9" + }, + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "field_options": { + "date_format": "DD - MM - YYYY" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditResponseExample.json b/examples/json/SignatureRequestEditResponseExample.json new file mode 100644 index 000000000..52834625a --- /dev/null +++ b/examples/json/SignatureRequestEditResponseExample.json @@ -0,0 +1,76 @@ +{ + "signature_request": { + "signature_request_id": "2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "title": "NDA with Acme Co.", + "original_title": "The NDA we talked about", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + "test_mode": true, + "metadata": { + "custom_id": "1234", + "custom_text": "NDA #9" + }, + "created_at": 1570471067, + "is_complete": false, + "is_declined": false, + "has_error": false, + "custom_fields": [], + "response_data": [], + "signing_url": "https://app.hellosign.com/sign/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "signing_redirect_url": null, + "files_url": "https://api.hellosign.com/v3/signature_request/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "details_url": "https://app.hellosign.com/home/manage?guid=2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "requester_email_address": "me@dropboxsign.com", + "signatures": [ + { + "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3", + "signer_email_address": "jack@example.com", + "signer_name": "Jack", + "signer_role": null, + "order": 0, + "status_code": "awaiting_signature", + "signed_at": null, + "last_viewed_at": null, + "last_reminded_at": null, + "has_pin": false, + "has_sms_auth": false + }, + { + "signature_id": "616629ed37f8588d28600be17ab5d6b7", + "signer_email_address": "jill@example.com", + "signer_name": "Jill", + "signer_role": null, + "order": 1, + "status_code": "awaiting_signature", + "signed_at": null, + "last_viewed_at": null, + "last_reminded_at": null, + "has_pin": false, + "has_sms_auth": false + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@example.com" + ], + "attachments": [ + { + "id": "id_1", + "signer": "1", + "name": "Attachment #1", + "required": true, + "instructions": "Instructions #1", + "uploaded_at": 1650398513 + }, + { + "id": "id_2", + "signer": "2", + "name": "Attachment #2", + "required": true, + "instructions": null, + "uploaded_at": null + } + ], + "template_ids": null + } +} diff --git a/examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json new file mode 100644 index 000000000..a79d1c35b --- /dev/null +++ b/examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json @@ -0,0 +1,36 @@ +{ + "template_ids": [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + ], + "subject": "Purchase Order", + "message": "Glad we could come to an agreement.", + "signers": [ + { + "role": "Client", + "name": "George", + "email_address": "george@example.com" + } + ], + "ccs": [ + { + "role": "Accounting", + "email_address": "accounting@example.com" + } + ], + "custom_fields": [ + { + "name": "Cost", + "value": "$20,000", + "editor": "Client", + "required": true + } + ], + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditWithTemplateResponseExample.json b/examples/json/SignatureRequestEditWithTemplateResponseExample.json new file mode 100644 index 000000000..8df366a7a --- /dev/null +++ b/examples/json/SignatureRequestEditWithTemplateResponseExample.json @@ -0,0 +1,46 @@ +{ + "signature_request": { + "signature_request_id": "17d163069282df5eb63857d31ff4a3bffa9e46c0", + "title": "Purchase Order", + "original_title": "Purchase Order", + "subject": "Purchase Order", + "metadata": {}, + "message": "Glad we could come to an agreement.", + "created_at": 1570471067, + "is_complete": false, + "is_declined": false, + "has_error": false, + "custom_fields": [ + { + "name": "Cost", + "value": "$20,000", + "type": "text", + "editor": "Client", + "required": true + } + ], + "response_data": [], + "signing_url": "https://app.hellosign.com/sign/17d163069282df5eb63857d31ff4a3bffa9e46c0", + "signing_redirect_url": null, + "details_url": "https://app.hellosign.com/home/manage?guid=17d163069282df5eb63857d31ff4a3bffa9e46c0", + "requester_email_address": "me@dropboxsign.com", + "signatures": [ + { + "signature_id": "10ab1cd037d9b6cba7975d61ff428c8d", + "signer_email_address": "george@example.com", + "signer_name": "George", + "signer_role": "Client", + "order": null, + "status_code": "awaiting_signature", + "signed_at": null, + "last_viewed_at": null, + "last_reminded_at": null, + "has_pin": false, + "has_sms_auth": false + } + ], + "cc_email_addresses": [ + "accounting@dropboxsign.com" + ] + } +} diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 64d635940..b03c3d48d 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -1820,7 +1820,6 @@ paths: - CA - US - UK - example: US - name: state in: query @@ -2102,7 +2101,6 @@ paths: required: true schema: type: string - example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -3547,6 +3545,496 @@ paths: seo: title: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE' description: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::DESCRIPTION' + '/signature_request/edit/{signature_request_id}': + put: + tags: + - 'Signature Request' + summary: '_t__SignatureRequestEdit::SUMMARY' + description: '_t__SignatureRequestEdit::DESCRIPTION' + operationId: signatureRequestEdit + parameters: + - + name: signature_request_id + in: path + description: '_t__SignatureRequestEdit::SIGNATURE_REQUEST_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' + 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/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditResponseExample' + 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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/SignatureRequestEdit.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/SignatureRequestEdit.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/SignatureRequestEdit.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/SignatureRequestEdit.ts + - + lang: Java + label: Java + source: + $ref: examples/SignatureRequestEdit.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/SignatureRequestEdit.rb + - + lang: Python + label: Python + source: + $ref: examples/SignatureRequestEdit.py + - + lang: cURL + label: cURL + source: + $ref: examples/SignatureRequestEdit.sh + x-meta: + seo: + title: '_t__SignatureRequestEdit::SEO::TITLE' + description: '_t__SignatureRequestEdit::SEO::DESCRIPTION' + x-hideOn: doc + x-beta: closed + '/signature_request/edit_embedded/{signature_request_id}': + put: + tags: + - 'Signature Request' + summary: '_t__SignatureRequestEditEmbedded::SUMMARY' + description: '_t__SignatureRequestEditEmbedded::DESCRIPTION' + operationId: signatureRequestEditEmbedded + parameters: + - + name: signature_request_id + in: path + description: '_t__SignatureRequestEditEmbedded::SIGNATURE_REQUEST_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' + 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/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample' + 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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/SignatureRequestEditEmbedded.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/SignatureRequestEditEmbedded.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/SignatureRequestEditEmbedded.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/SignatureRequestEditEmbedded.ts + - + lang: Java + label: Java + source: + $ref: examples/SignatureRequestEditEmbedded.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/SignatureRequestEditEmbedded.rb + - + lang: Python + label: Python + source: + $ref: examples/SignatureRequestEditEmbedded.py + - + lang: cURL + label: cURL + source: + $ref: examples/SignatureRequestEditEmbedded.sh + x-meta: + seo: + title: '_t__SignatureRequestEditEmbedded::SEO::TITLE' + description: '_t__SignatureRequestEditEmbedded::SEO::DESCRIPTION' + x-hideOn: doc + x-beta: closed + '/signature_request/edit_embedded_with_template/{signature_request_id}': + put: + tags: + - 'Signature Request' + summary: '_t__SignatureRequestEditEmbeddedWithTemplate::SUMMARY' + description: '_t__SignatureRequestEditEmbeddedWithTemplate::DESCRIPTION' + operationId: signatureRequestEditEmbeddedWithTemplate + parameters: + - + name: signature_request_id + in: path + description: '_t__SignatureRequestEditEmbeddedWithTemplate::SIGNATURE_REQUEST_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' + 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/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample' + 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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts + - + lang: Java + label: Java + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb + - + lang: Python + label: Python + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py + - + lang: cURL + label: cURL + source: + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh + x-meta: + seo: + title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::DESCRIPTION' + x-hideOn: doc + x-beta: closed + '/signature_request/edit_with_template/{signature_request_id}': + put: + tags: + - 'Signature Request' + summary: '_t__SignatureRequestEditWithTemplate::SUMMARY' + description: '_t__SignatureRequestEditWithTemplate::DESCRIPTION' + operationId: signatureRequestEditWithTemplate + parameters: + - + name: signature_request_id + in: path + description: '_t__SignatureRequestEditWithTemplate::SIGNATURE_REQUEST_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' + 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/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample' + 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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/SignatureRequestEditWithTemplate.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/SignatureRequestEditWithTemplate.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/SignatureRequestEditWithTemplate.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/SignatureRequestEditWithTemplate.ts + - + lang: Java + label: Java + source: + $ref: examples/SignatureRequestEditWithTemplate.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/SignatureRequestEditWithTemplate.rb + - + lang: Python + label: Python + source: + $ref: examples/SignatureRequestEditWithTemplate.py + - + lang: cURL + label: cURL + source: + $ref: examples/SignatureRequestEditWithTemplate.sh + x-meta: + seo: + title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestEditWithTemplate::SEO::DESCRIPTION' + x-hideOn: doc + x-beta: closed '/signature_request/files/{signature_request_id}': get: tags: @@ -7768,6 +8256,10 @@ components: - US - UK x-enum-varnames-override: + csharp: + - CA + - US + - UK typescript-node: - Ca - Us @@ -7915,27 +8407,249 @@ components: description: '_t__ReportCreate::START_DATE' type: string type: object - SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + properties: + template_ids: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TEMPLATE_IDS' + type: array + items: + type: string + signer_file: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_FILE' + type: string + format: binary + signer_list: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_LIST' + type: array + items: + $ref: '#/components/schemas/SubBulkSignerList' + allow_decline: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::ALLOW_DECLINE' + type: boolean + default: false + ccs: + description: '_t__Sub::CC::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::CLIENT_ID' + type: string + custom_fields: + description: '_t__Sub::CustomField::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::MESSAGE' + type: string + maxLength: 5000 + metadata: + description: '_t__Sub::Metadata::DESCRIPTION' + type: object + maxItems: 10 + additionalProperties: { } + signing_redirect_url: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL' + type: string + subject: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SUBJECT' + type: string + maxLength: 255 + test_mode: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TEST_MODE' + type: boolean + default: false + title: + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TITLE' + type: string + maxLength: 255 + type: object + SignatureRequestBulkSendWithTemplateRequest: + required: + - template_ids + properties: + template_ids: + description: '_t__SignatureRequestBulkSendWithTemplate::TEMPLATE_IDS' + type: array + items: + type: string + signer_file: + description: '_t__SignatureRequestBulkSendWithTemplate::SIGNER_FILE' + type: string + format: binary + signer_list: + description: '_t__SignatureRequestBulkSendWithTemplate::SIGNER_LIST' + type: array + items: + $ref: '#/components/schemas/SubBulkSignerList' + allow_decline: + description: '_t__SignatureRequestBulkSendWithTemplate::ALLOW_DECLINE' + type: boolean + default: false + ccs: + description: '_t__Sub::CC::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: '_t__SignatureRequestBulkSendWithTemplate::CLIENT_ID' + type: string + custom_fields: + description: '_t__Sub::CustomField::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: '_t__SignatureRequestBulkSendWithTemplate::MESSAGE' + type: string + maxLength: 5000 + metadata: + description: '_t__Sub::Metadata::DESCRIPTION' + type: object + maxItems: 10 + additionalProperties: { } + signing_redirect_url: + description: '_t__SignatureRequestBulkSendWithTemplate::SIGNING_REDIRECT_URL' + type: string + subject: + description: '_t__SignatureRequestBulkSendWithTemplate::SUBJECT' + type: string + maxLength: 255 + test_mode: + description: '_t__SignatureRequestBulkSendWithTemplate::TEST_MODE' + type: boolean + default: false + title: + description: '_t__SignatureRequestBulkSendWithTemplate::TITLE' + type: string + maxLength: 255 + type: object + SignatureRequestCreateEmbeddedRequest: + required: + - client_id + properties: + files: + description: '_t__SignatureRequestCreateEmbedded::FILES' + type: array + items: + type: string + format: binary + file_urls: + description: '_t__SignatureRequestCreateEmbedded::FILE_URLS' + type: array + items: + type: string + signers: + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: '_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE' + type: boolean + default: false + allow_reassign: + description: '_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN' + type: boolean + default: false + attachments: + description: '_t__SubAttachment::LIST_DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: '_t__SignatureRequestCreateEmbedded::CC_EMAIL_ADDRESSES' + type: array + items: + type: string + format: email + client_id: + description: '_t__SignatureRequestCreateEmbedded::CLIENT_ID' + type: string + custom_fields: + description: '_t__Sub::CustomField::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: '_t__Sub::FormFieldGroup::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: '_t__Sub::FormFieldRule::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: '_t__SignatureRequestCreateEmbedded::HIDE_TEXT_TAGS' + type: boolean + default: false + message: + description: '_t__SignatureRequestCreateEmbedded::MESSAGE' + type: string + maxLength: 5000 + metadata: + description: '_t__Sub::Metadata::DESCRIPTION' + type: object + maxItems: 10 + additionalProperties: { } + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: '_t__SignatureRequestCreateEmbedded::SUBJECT' + type: string + maxLength: 255 + test_mode: + description: '_t__SignatureRequestCreateEmbedded::TEST_MODE' + type: boolean + default: false + title: + description: '_t__SignatureRequestCreateEmbedded::TITLE' + type: string + maxLength: 255 + use_text_tags: + description: '_t__SignatureRequestCreateEmbedded::USE_TEXT_TAGS' + type: boolean + default: false + populate_auto_fill_fields: + description: '_t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' + type: boolean + default: false + expires_at: + description: '_t__SignatureRequestCreateEmbedded::EXPIRES_AT' + type: integer + nullable: true + type: object + SignatureRequestCreateEmbeddedWithTemplateRequest: required: - client_id - template_ids + - signers properties: template_ids: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TEMPLATE_IDS' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::TEMPLATE_IDS' type: array items: type: string - signer_file: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_FILE' - type: string - format: binary - signer_list: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_LIST' - type: array - items: - $ref: '#/components/schemas/SubBulkSignerList' allow_decline: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::ALLOW_DECLINE' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::ALLOW_DECLINE' type: boolean default: false ccs: @@ -7944,15 +8658,26 @@ components: items: $ref: '#/components/schemas/SubCC' client_id: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::CLIENT_ID' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::CLIENT_ID' type: string custom_fields: - description: '_t__Sub::CustomField::DESCRIPTION' + description: '_t__Sub::CustomField::TEMPLATE' type: array items: $ref: '#/components/schemas/SubCustomField' + files: + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::FILES' + type: array + items: + type: string + format: binary + file_urls: + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::FILE_URLS' + type: array + items: + type: string message: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::MESSAGE' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::MESSAGE' type: string maxLength: 5000 metadata: @@ -7960,59 +8685,107 @@ components: type: object maxItems: 10 additionalProperties: { } - signing_redirect_url: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL' - type: string + signers: + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' subject: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SUBJECT' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::SUBJECT' type: string maxLength: 255 test_mode: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TEST_MODE' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::TEST_MODE' type: boolean default: false title: - description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::TITLE' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::TITLE' type: string maxLength: 255 + populate_auto_fill_fields: + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS' + type: boolean + default: false type: object - SignatureRequestBulkSendWithTemplateRequest: - required: - - template_ids + SignatureRequestEditRequest: properties: - template_ids: - description: '_t__SignatureRequestBulkSendWithTemplate::TEMPLATE_IDS' + files: + description: '_t__SignatureRequestSend::FILES' type: array items: type: string - signer_file: - description: '_t__SignatureRequestBulkSendWithTemplate::SIGNER_FILE' - type: string - format: binary - signer_list: - description: '_t__SignatureRequestBulkSendWithTemplate::SIGNER_LIST' + format: binary + file_urls: + description: '_t__SignatureRequestSend::FILE_URLS' type: array items: - $ref: '#/components/schemas/SubBulkSignerList' + type: string + signers: + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: - description: '_t__SignatureRequestBulkSendWithTemplate::ALLOW_DECLINE' + description: '_t__SignatureRequestSend::ALLOW_DECLINE' type: boolean default: false - ccs: - description: '_t__Sub::CC::DESCRIPTION' + allow_reassign: + description: '_t__SignatureRequestSend::ALLOW_REASSIGN' + type: boolean + default: false + attachments: + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: - $ref: '#/components/schemas/SubCC' + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: '_t__SignatureRequestSend::CC_EMAIL_ADDRESSES' + type: array + items: + type: string + format: email client_id: - description: '_t__SignatureRequestBulkSendWithTemplate::CLIENT_ID' + description: '_t__SignatureRequestSend::CLIENT_ID' type: string custom_fields: description: '_t__Sub::CustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: '_t__Sub::FormFieldGroup::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: '_t__Sub::FormFieldRule::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: '_t__SignatureRequestSend::HIDE_TEXT_TAGS' + type: boolean + default: false + is_eid: + description: '_t__SignatureRequestSend::IS_EID' + type: boolean + default: false message: - description: '_t__SignatureRequestBulkSendWithTemplate::MESSAGE' + description: '_t__SignatureRequestSend::MESSAGE' type: string maxLength: 5000 metadata: @@ -8020,23 +8793,33 @@ components: type: object maxItems: 10 additionalProperties: { } + signing_options: + $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: - description: '_t__SignatureRequestBulkSendWithTemplate::SIGNING_REDIRECT_URL' + description: '_t__SignatureRequestSend::SIGNING_REDIRECT_URL' type: string subject: - description: '_t__SignatureRequestBulkSendWithTemplate::SUBJECT' + description: '_t__SignatureRequestSend::SUBJECT' type: string maxLength: 255 test_mode: - description: '_t__SignatureRequestBulkSendWithTemplate::TEST_MODE' + description: '_t__SignatureRequestSend::TEST_MODE' type: boolean default: false title: - description: '_t__SignatureRequestBulkSendWithTemplate::TITLE' + description: '_t__SignatureRequestSend::TITLE' type: string maxLength: 255 + use_text_tags: + description: '_t__SignatureRequestSend::USE_PREEXISTING_FIELDS' + type: boolean + default: false + expires_at: + description: '_t__SignatureRequestSend::EXPIRES_AT' + type: integer + nullable: true type: object - SignatureRequestCreateEmbeddedRequest: + SignatureRequestEditEmbeddedRequest: required: - client_id properties: @@ -8145,7 +8928,7 @@ components: type: integer nullable: true type: object - SignatureRequestCreateEmbeddedWithTemplateRequest: + SignatureRequestEditEmbeddedWithTemplateRequest: required: - client_id - template_ids @@ -8217,6 +9000,81 @@ components: type: boolean default: false type: object + SignatureRequestEditWithTemplateRequest: + description: '' + required: + - signers + - template_ids + properties: + template_ids: + description: '_t__SignatureRequestSendWithTemplate::TEMPLATE_IDS' + type: array + items: + type: string + allow_decline: + description: '_t__SignatureRequestSendWithTemplate::ALLOW_DECLINE' + type: boolean + default: false + ccs: + description: '_t__Sub::CC::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: '_t__SignatureRequestSendWithTemplate::CLIENT_ID' + type: string + custom_fields: + description: '_t__Sub::CustomField::TEMPLATE' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: '_t__SignatureRequestSendWithTemplate::FILES' + type: array + items: + type: string + format: binary + file_urls: + description: '_t__SignatureRequestSendWithTemplate::FILE_URLS' + type: array + items: + type: string + is_eid: + description: '_t__SignatureRequestSendWithTemplate::IS_EID' + type: boolean + default: false + message: + description: '_t__SignatureRequestSendWithTemplate::MESSAGE' + type: string + maxLength: 5000 + metadata: + description: '_t__Sub::Metadata::DESCRIPTION' + type: object + maxItems: 10 + additionalProperties: { } + signers: + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: '_t__SignatureRequestSendWithTemplate::SIGNING_REDIRECT_URL' + type: string + subject: + description: '_t__SignatureRequestSendWithTemplate::SUBJECT' + type: string + maxLength: 255 + test_mode: + description: '_t__SignatureRequestSendWithTemplate::TEST_MODE' + type: boolean + default: false + title: + description: '_t__SignatureRequestSendWithTemplate::TITLE' + type: string + maxLength: 255 + type: object SignatureRequestRemindRequest: required: - email_address @@ -8623,6 +9481,9 @@ components: csharp: - FieldVisibility - GroupVisibility + java: + - FIELD_VISIBILITY + - GROUP_VISIBILITY php: - TYPE_FIELD_VISIBILITY - TYPE_GROUP_VISIBILITY @@ -12390,6 +13251,30 @@ components: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json + SignatureRequestEditRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditRequestDefaultExample.json + SignatureRequestEditRequestGroupedSignersExample: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json + SignatureRequestEditEmbeddedRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json + SignatureRequestEditEmbeddedRequestGroupedSignersExample: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json + SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json + SignatureRequestEditWithTemplateRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json SignatureRequestRemindRequestDefaultExample: summary: 'Default Example' value: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 304c1c17f..8b67ae6a9 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1826,7 +1826,6 @@ paths: - CA - US - UK - example: US - name: state in: query @@ -2108,7 +2107,6 @@ paths: required: true schema: type: string - example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -3571,35 +3569,39 @@ paths: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' - '/signature_request/files/{signature_request_id}': - get: + '/signature_request/edit/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files' + summary: 'Edit Signature Request' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. + Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFiles + **NOTE:** Edit and resend will not deduct your signature request quota. + operationId: signatureRequestEdit parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - default: pdf - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' responses: '200': description: 'successful operation' @@ -3611,14 +3613,12 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditResponseExample' '4XX': description: failed_operation content: @@ -3638,8 +3638,6 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: @@ -3656,65 +3654,78 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestEdit.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs + $ref: examples/SignatureRequestEdit.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestEdit.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestEdit.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestEdit.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestEdit.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestEdit.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestEdit.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_data_uri/{signature_request_id}': - get: + title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.' + x-hideOn: doc + x-beta: closed + '/signature_request/edit_embedded/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as Data Uri' - description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). - - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsDataUri + summary: 'Edit Embedded Signature Request' + description: 'Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.' + operationId: signatureRequestEditEmbedded parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' responses: '200': description: 'successful operation' @@ -3728,10 +3739,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample' '4XX': description: failed_operation content: @@ -3751,8 +3762,6 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: @@ -3762,79 +3771,82 @@ paths: api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestEditEmbedded.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs + $ref: examples/SignatureRequestEditEmbedded.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestEditEmbedded.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestEditEmbedded.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestEditEmbedded.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestEditEmbedded.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestEditEmbedded.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestEditEmbedded.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_file_url/{signature_request_id}': - get: + title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.' + x-hideOn: doc + x-beta: closed + '/signature_request/edit_embedded_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as File Url' - description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). - - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsFileUrl + summary: 'Edit Embedded Signature Request with Template' + description: 'Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.' + operationId: signatureRequestEditEmbeddedWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: force_download - in: query - description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' - schema: - type: integer - default: 1 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' responses: '200': description: 'successful operation' @@ -3848,10 +3860,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample' '4XX': description: failed_operation content: @@ -3871,8 +3883,6 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: @@ -3882,69 +3892,85 @@ paths: api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/{signature_request_id}': - get: + title: 'Signature Request with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.' + x-hideOn: doc + x-beta: closed + '/signature_request/edit_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Get Signature Request' - description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' - operationId: signatureRequestGet + summary: 'Edit Signature Request With Template' + description: |- + Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. + + **NOTE:** Edit and resend will not deduct your signature request quota. + operationId: signatureRequestEditWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' responses: '200': description: 'successful operation' @@ -3961,7 +3987,7 @@ paths: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample' '4XX': description: failed_operation content: @@ -3979,8 +4005,10 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -3995,84 +4023,77 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestEditWithTemplate.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs + $ref: examples/SignatureRequestEditWithTemplate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestEditWithTemplate.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestEditWithTemplate.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestEditWithTemplate.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestEditWithTemplate.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestEditWithTemplate.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestEditWithTemplate.sh x-meta: seo: - title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' - /signature_request/list: + title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.' + x-hideOn: doc + x-beta: closed + '/signature_request/files/{signature_request_id}': get: tags: - 'Signature Request' - summary: 'List Signature Requests' + summary: 'Download Files' description: |- - Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. - operationId: signatureRequestList + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFiles parameters: - - name: account_id - in: query - description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to retrieve.' + required: true schema: type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - name: page - in: query - description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - example: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - - - name: query + name: file_type in: query - description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + default: pdf + enum: + - pdf + - zip responses: '200': description: 'successful operation' @@ -4084,12 +4105,14 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/SignatureRequestListResponse' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + type: string + format: binary + application/zip: + schema: + type: string + format: binary '4XX': description: failed_operation content: @@ -4105,8 +4128,14 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -4121,58 +4150,61 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestFiles.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs + $ref: examples/SignatureRequestFiles.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestFiles.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestFiles.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestFiles.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestFiles.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestFiles.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestFiles.sh x-meta: seo: - title: 'List Signature Requests | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' - '/signature_request/release_hold/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_data_uri/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Release On-Hold Signature Request' - description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' - operationId: signatureRequestReleaseHold - parameters: - - - name: signature_request_id - in: path - description: 'The id of the SignatureRequest to release.' + summary: 'Download Files as Data Uri' + description: |- + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsDataUri + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string @@ -4190,10 +4222,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + $ref: '#/components/examples/SignatureRequestFilesResponseExample' '4XX': description: failed_operation content: @@ -4211,6 +4243,12 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -4218,80 +4256,79 @@ paths: api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestFilesAsDataUri.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs + $ref: examples/SignatureRequestFilesAsDataUri.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestFilesAsDataUri.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestFilesAsDataUri.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestFilesAsDataUri.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestFilesAsDataUri.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestFilesAsDataUri.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestFilesAsDataUri.sh x-meta: seo: - title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' - '/signature_request/remind/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_file_url/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Send Request Reminder' + summary: 'Download Files as File Url' description: |- - Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). - **NOTE:** This action can **not** be used with embedded signature requests. - operationId: signatureRequestRemind + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsFileUrl parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to send a reminder for.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestRemindRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + - + name: force_download + in: query + description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' + schema: + type: integer + default: 1 responses: '200': description: 'successful operation' @@ -4305,10 +4342,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + $ref: '#/components/examples/SignatureRequestFilesResponseExample' '4XX': description: failed_operation content: @@ -4346,63 +4383,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestFilesAsFileUrl.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs + $ref: examples/SignatureRequestFilesAsFileUrl.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestFilesAsFileUrl.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestFilesAsFileUrl.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestFilesAsFileUrl.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestFilesAsFileUrl.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestFilesAsFileUrl.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestFilesAsFileUrl.sh x-meta: seo: - title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' - '/signature_request/remove/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Remove Signature Request Access' - description: |- - Removes your access to a completed signature request. This action is **not reversible**. - - The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). - - Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. - operationId: signatureRequestRemove + summary: 'Get Signature Request' + description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' + operationId: signatureRequestGet parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to remove.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string @@ -4418,7 +4450,12 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestGetResponseExample' '4XX': description: failed_operation content: @@ -4436,8 +4473,6 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: @@ -4445,72 +4480,93 @@ paths: security: - api_key: [] + - + oauth2: + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestGet.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs + $ref: examples/SignatureRequestGet.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestGet.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestGet.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestGet.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestGet.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestGet.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestGet.sh x-meta: seo: - title: 'Remove Signature Request Access | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' - /signature_request/send: - post: + title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' + /signature_request/list: + get: tags: - 'Signature Request' - summary: 'Send Signature Request' - description: 'Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.' - operationId: signatureRequestSend - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' - grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' + summary: 'List Signature Requests' + description: |- + Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + + Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + operationId: signatureRequestList + parameters: + - + name: account_id + in: query + description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + example: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + schema: + type: string responses: '200': description: 'successful operation' @@ -4524,10 +4580,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/SignatureRequestListResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + $ref: '#/components/examples/SignatureRequestListResponseExample' '4XX': description: failed_operation content: @@ -4545,8 +4601,6 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -4561,65 +4615,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestList.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs + $ref: examples/SignatureRequestList.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestList.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestList.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestList.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestList.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestList.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestList.sh x-meta: seo: - title: 'Send Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' - /signature_request/send_with_template: + title: 'List Signature Requests | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' + '/signature_request/release_hold/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Send with Template' - description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' - operationId: signatureRequestSendWithTemplate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + summary: 'Release On-Hold Signature Request' + description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' + operationId: signatureRequestReleaseHold + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to release.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: '200': description: 'successful operation' @@ -4636,7 +4687,7 @@ paths: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' '4XX': description: failed_operation content: @@ -4652,8 +4703,8 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -4661,70 +4712,67 @@ paths: api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestReleaseHold.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs + $ref: examples/SignatureRequestReleaseHold.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestReleaseHold.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestReleaseHold.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestReleaseHold.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestReleaseHold.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestReleaseHold.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestReleaseHold.sh x-meta: seo: - title: 'Send with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' - '/signature_request/update/{signature_request_id}': + title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' + '/signature_request/remind/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Update Signature Request' + summary: 'Send Request Reminder' description: |- - Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. - - Updating the email address of a signer will generate a new `signature_id` value. + Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. - **NOTE:** This action cannot be performed on a signature request with an appended signature page. - operationId: signatureRequestUpdate + **NOTE:** This action can **not** be used with embedded signature requests. + operationId: signatureRequestRemind parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to update.' + description: 'The id of the SignatureRequest to send a reminder for.' required: true schema: type: string @@ -4734,10 +4782,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestUpdateRequest' + $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' responses: '200': description: 'successful operation' @@ -4754,7 +4802,7 @@ paths: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + $ref: '#/components/examples/SignatureRequestRemindResponseExample' '4XX': description: failed_operation content: @@ -4772,6 +4820,12 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -4779,79 +4833,74 @@ paths: api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestRemind.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs + $ref: examples/SignatureRequestRemind.cs - lang: JavaScript label: JavaScript source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestRemind.js - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestRemind.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestRemind.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestRemind.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestRemind.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestRemind.sh x-meta: seo: - title: 'Update Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' - /team/add_member: - put: + title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' + '/signature_request/remove/{signature_request_id}': + post: tags: - - Team - summary: 'Add User to Team' - description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' - operationId: teamAddMember + - 'Signature Request' + summary: 'Remove Signature Request Access' + description: |- + Removes your access to a completed signature request. This action is **not reversible**. + + The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). + + Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + operationId: signatureRequestRemove parameters: - - name: team_id - in: query - description: 'The id of the team.' - required: false + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to remove.' + required: true schema: type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TeamAddMemberRequest' - examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: '200': description: 'successful operation' @@ -4863,12 +4912,7 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TeamGetResponse' - examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + application/json: {} '4XX': description: failed_operation content: @@ -4886,75 +4930,81 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - - - oauth2: - - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/SignatureRequestRemove.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs + $ref: examples/SignatureRequestRemove.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamAddMember.js + $ref: examples/SignatureRequestRemove.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/SignatureRequestRemove.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/SignatureRequestRemove.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/SignatureRequestRemove.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/SignatureRequestRemove.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/SignatureRequestRemove.sh x-meta: seo: - title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' - /team/create: + title: 'Remove Signature Request Access | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' + /signature_request/send: post: tags: - - Team - summary: 'Create Team' - description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' - operationId: teamCreate + - 'Signature Request' + summary: 'Send Signature Request' + description: 'Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.' + operationId: signatureRequestSend requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamCreateRequest' + $ref: '#/components/schemas/SignatureRequestSendRequest' examples: default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendRequest' responses: '200': description: 'successful operation' @@ -4968,10 +5018,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + $ref: '#/components/examples/SignatureRequestSendResponseExample' '4XX': description: failed_operation content: @@ -4987,6 +5037,10 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -4994,59 +5048,72 @@ paths: api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/SignatureRequestSend.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs + $ref: examples/SignatureRequestSend.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamCreate.js + $ref: examples/SignatureRequestSend.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/SignatureRequestSend.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/SignatureRequestSend.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/SignatureRequestSend.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/SignatureRequestSend.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/SignatureRequestSend.sh x-meta: seo: - title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' - /team/destroy: - delete: + title: 'Send Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' + /signature_request/send_with_template: + post: tags: - - Team - summary: 'Delete Team' - description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' - operationId: teamDelete + - 'Signature Request' + summary: 'Send with Template' + description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' + operationId: signatureRequestSendWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: '200': description: 'successful operation' @@ -5057,6 +5124,13 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' '4XX': description: failed_operation content: @@ -5072,6 +5146,8 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5079,59 +5155,83 @@ paths: api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/SignatureRequestSendWithTemplate.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs + $ref: examples/SignatureRequestSendWithTemplate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamDelete.js + $ref: examples/SignatureRequestSendWithTemplate.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/SignatureRequestSendWithTemplate.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/SignatureRequestSendWithTemplate.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/SignatureRequestSendWithTemplate.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/SignatureRequestSendWithTemplate.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/SignatureRequestSendWithTemplate.sh x-meta: seo: - title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' - /team: - get: + title: 'Send with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' + '/signature_request/update/{signature_request_id}': + post: tags: - - Team - summary: 'Get Team' - description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' - operationId: teamGet + - 'Signature Request' + summary: 'Update Signature Request' + description: |- + Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. + + Updating the email address of a signer will generate a new `signature_id` value. + + **NOTE:** This action cannot be performed on a signature request with an appended signature page. + operationId: signatureRequestUpdate + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to update.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestUpdateRequest' + examples: + default_example: + $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' responses: '200': description: 'successful operation' @@ -5145,10 +5245,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: - $ref: '#/components/examples/TeamGetResponseExample' + $ref: '#/components/examples/SignatureRequestUpdateResponseExample' '4XX': description: failed_operation content: @@ -5173,67 +5273,79 @@ paths: api_key: [] - oauth2: - - team_access + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/SignatureRequestUpdate.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs + $ref: examples/SignatureRequestUpdate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamGet.js + $ref: examples/SignatureRequestUpdate.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/SignatureRequestUpdate.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/SignatureRequestUpdate.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/SignatureRequestUpdate.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/SignatureRequestUpdate.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/SignatureRequestUpdate.sh x-meta: seo: - title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + title: 'Update Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' + /team/add_member: put: tags: - Team - summary: 'Update Team' - description: 'Updates the name of your Team.' - operationId: teamUpdate + summary: 'Add User to Team' + description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' + operationId: teamAddMember + parameters: + - + name: team_id + in: query + description: 'The id of the team.' + required: false + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamUpdateRequest' + $ref: '#/components/schemas/TeamAddMemberRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + email_address: + $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' + account_id: + $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' responses: '200': description: 'successful operation' @@ -5250,7 +5362,7 @@ paths: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + $ref: '#/components/examples/TeamAddMemberResponseExample' '4XX': description: failed_operation content: @@ -5266,6 +5378,8 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5279,62 +5393,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamAddMember.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs + $ref: examples/TeamAddMember.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamAddMember.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamAddMember.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamAddMember.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamAddMember.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamAddMember.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamAddMember.sh x-meta: seo: - title: 'Update Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' - /team/info: - get: + title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' + /team/create: + post: tags: - Team - summary: 'Get Team Info' - description: 'Provides information about a team.' - operationId: teamInfo - parameters: - - - name: team_id - in: query - description: 'The id of the team.' - required: false - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + summary: 'Create Team' + description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' + operationId: teamCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamCreateRequest' + examples: + default_example: + $ref: '#/components/examples/TeamCreateRequestDefaultExample' responses: '200': description: 'successful operation' @@ -5348,10 +5462,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetInfoResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + $ref: '#/components/examples/TeamCreateResponseExample' '4XX': description: failed_operation content: @@ -5367,10 +5481,6 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5384,61 +5494,53 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamCreate.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs + $ref: examples/TeamCreate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamInfo.js + $ref: examples/TeamCreate.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamCreate.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamCreate.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamCreate.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamCreate.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamCreate.sh x-meta: seo: - title: 'Get Team Info | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' - /team/invites: - get: + title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' + /team/destroy: + delete: tags: - Team - summary: 'List Team Invites' - description: 'Provides a list of team invites (and their roles).' - operationId: teamInvites - parameters: - - - name: email_address - in: query - description: 'The email address for which to display the team invites.' - required: false - schema: - type: string + summary: 'Delete Team' + description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' + operationId: teamDelete responses: '200': description: 'successful operation' @@ -5449,13 +5551,6 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - content: - application/json: - schema: - $ref: '#/components/schemas/TeamInvitesResponse' - examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' '4XX': description: failed_operation content: @@ -5478,85 +5573,59 @@ paths: api_key: [] - oauth2: - - account_access - - basic_account_info + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamDelete.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs + $ref: examples/TeamDelete.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamInvites.js + $ref: examples/TeamDelete.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamDelete.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamDelete.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamDelete.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamDelete.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamDelete.sh x-meta: seo: - title: 'List Team Invites | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' - '/team/members/{team_id}': + title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' + /team: get: tags: - Team - summary: 'List Team Members' - description: 'Provides a paginated list of members (and their roles) that belong to a given team.' - operationId: teamMembers - parameters: - - - name: team_id - in: path - description: 'The id of the team that a member list is being requested from.' - required: true - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the team member list to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 + summary: 'Get Team' + description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' + operationId: teamGet responses: '200': description: 'successful operation' @@ -5570,10 +5639,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamMembersResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + $ref: '#/components/examples/TeamGetResponseExample' '4XX': description: failed_operation content: @@ -5589,10 +5658,8 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5606,66 +5673,63 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamGet.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs + $ref: examples/TeamGet.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamMembers.js + $ref: examples/TeamGet.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamGet.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamGet.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamGet.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamGet.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamGet.sh x-meta: seo: - title: 'List Team Members | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' - /team/remove_member: - post: + title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + put: tags: - Team - summary: 'Remove User from Team' - description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' - operationId: teamRemoveMember + summary: 'Update Team' + description: 'Updates the name of your Team.' + operationId: teamUpdate requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamRemoveMemberRequest' + $ref: '#/components/schemas/TeamUpdateRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + default_example: + $ref: '#/components/examples/TeamUpdateRequestDefaultExample' responses: - '201': + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5680,7 +5744,7 @@ paths: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + $ref: '#/components/examples/TeamUpdateResponseExample' '4XX': description: failed_operation content: @@ -5696,8 +5760,6 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5711,78 +5773,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamUpdate.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs + $ref: examples/TeamUpdate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamUpdate.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamUpdate.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamUpdate.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamUpdate.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamUpdate.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamUpdate.sh x-meta: seo: - title: 'Remove User from Team | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' - '/team/sub_teams/{team_id}': + title: 'Update Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' + /team/info: get: tags: - Team - summary: 'List Sub Teams' - description: 'Provides a paginated list of sub teams that belong to a given team.' - operationId: teamSubTeams + summary: 'Get Team Info' + description: 'Provides information about a team.' + operationId: teamInfo parameters: - name: team_id - in: path - description: 'The id of the parent Team.' - required: true + in: query + description: 'The id of the team.' + required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the SubTeam List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 responses: '200': description: 'successful operation' @@ -5796,10 +5842,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamSubTeamsResponse' + $ref: '#/components/schemas/TeamGetInfoResponse' examples: default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + $ref: '#/components/examples/TeamGetInfoResponseExample' '4XX': description: failed_operation content: @@ -5832,71 +5878,61 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamInfo.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs + $ref: examples/TeamInfo.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamInfo.js - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamInfo.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamInfo.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamInfo.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamInfo.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamInfo.sh x-meta: seo: - title: 'List Sub Teams | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' - '/template/add_user/{template_id}': - post: + title: 'Get Team Info | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' + /team/invites: + get: tags: - - Template - summary: 'Add User to Template' - description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' - operationId: templateAddUser + - Team + summary: 'List Team Invites' + description: 'Provides a list of team invites (and their roles).' + operationId: teamInvites parameters: - - name: template_id - in: path - description: 'The id of the Template to give the Account access to.' - required: true + name: email_address + in: query + description: 'The email address for which to display the team invites.' + required: false schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateAddUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: '200': description: 'successful operation' @@ -5910,10 +5946,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/TeamInvitesResponse' examples: default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + $ref: '#/components/examples/TeamInvitesResponseExample' '4XX': description: failed_operation content: @@ -5929,8 +5965,6 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -5938,77 +5972,85 @@ paths: api_key: [] - oauth2: - - template_access + - account_access + - basic_account_info x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TeamInvites.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs + $ref: examples/TeamInvites.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateAddUser.js + $ref: examples/TeamInvites.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TeamInvites.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TeamInvites.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TeamInvites.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TeamInvites.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TeamInvites.sh x-meta: seo: - title: 'Add User to Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' - /template/create: - post: + title: 'List Team Invites | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' + '/team/members/{team_id}': + get: tags: - - Template - summary: 'Create Template' - description: 'Creates a template that can then be used.' - operationId: templateCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' + - Team + summary: 'List Team Members' + description: 'Provides a paginated list of members (and their roles) that belong to a given team.' + operationId: teamMembers + parameters: + - + name: team_id + in: path + description: 'The id of the team that a member list is being requested from.' + required: true + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the team member list to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 responses: '200': description: 'successful operation' @@ -6022,10 +6064,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateResponse' + $ref: '#/components/schemas/TeamMembersResponse' examples: default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + $ref: '#/components/examples/TeamMembersResponseExample' '4XX': description: failed_operation content: @@ -6041,10 +6083,10 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6052,79 +6094,72 @@ paths: api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TeamMembers.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs + $ref: examples/TeamMembers.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateCreate.js + $ref: examples/TeamMembers.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TeamMembers.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TeamMembers.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TeamMembers.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TeamMembers.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TeamMembers.sh x-meta: seo: - title: 'Create Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' - /template/create_embedded_draft: + title: 'List Team Members | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' + /team/remove_member: post: tags: - - Template - summary: 'Create Embedded Template Draft' - description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' - operationId: templateCreateEmbeddedDraft + - Team + summary: 'Remove User from Team' + description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' + operationId: teamRemoveMember requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + email_address: + $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' + account_id: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' responses: - '200': + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6136,10 +6171,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + $ref: '#/components/examples/TeamRemoveMemberResponseExample' '4XX': description: failed_operation content: @@ -6157,8 +6192,6 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6166,68 +6199,84 @@ paths: api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TeamRemoveMember.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs + $ref: examples/TeamRemoveMember.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TeamRemoveMember.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TeamRemoveMember.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TeamRemoveMember.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TeamRemoveMember.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TeamRemoveMember.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TeamRemoveMember.sh x-meta: seo: - title: 'Create Embedded Template Draft | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' - '/template/delete/{template_id}': - post: + title: 'Remove User from Team | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' + '/team/sub_teams/{team_id}': + get: tags: - - Template - summary: 'Delete Template' - description: 'Completely deletes the template specified from the account.' - operationId: templateDelete + - Team + summary: 'List Sub Teams' + description: 'Provides a paginated list of sub teams that belong to a given team.' + operationId: teamSubTeams parameters: - - name: template_id + name: team_id in: path - description: 'The id of the Template to delete.' + description: 'The id of the parent Team.' required: true schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the SubTeam List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 responses: '200': description: 'successful operation' @@ -6239,7 +6288,12 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/TeamSubTeamsResponse' + examples: + default_example: + $ref: '#/components/examples/TeamSubTeamsResponseExample' '4XX': description: failed_operation content: @@ -6255,10 +6309,10 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6266,80 +6320,77 @@ paths: api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TeamSubTeams.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs + $ref: examples/TeamSubTeams.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateDelete.js + $ref: examples/TeamSubTeams.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TeamSubTeams.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TeamSubTeams.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TeamSubTeams.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TeamSubTeams.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TeamSubTeams.sh x-meta: seo: - title: 'Delete Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' - '/template/files/{template_id}': - get: + title: 'List Sub Teams | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' + '/template/add_user/{template_id}': + post: tags: - Template - summary: 'Get Template Files' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - - If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. - operationId: templateFiles + summary: 'Add User to Template' + description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' + operationId: templateAddUser parameters: - name: template_id in: path - description: 'The id of the template files to retrieve.' + description: 'The id of the Template to give the Account access to.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateAddUserRequest' + examples: + default_example: + $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: '200': description: 'successful operation' @@ -6351,14 +6402,12 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary + $ref: '#/components/schemas/TemplateGetResponse' + examples: + default_example: + $ref: '#/components/examples/TemplateAddUserResponseExample' '4XX': description: failed_operation content: @@ -6376,12 +6425,6 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6395,65 +6438,71 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateAddUser.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs + $ref: examples/TemplateAddUser.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateAddUser.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateAddUser.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateAddUser.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateAddUser.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateAddUser.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateAddUser.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_data_uri/{template_id}': - get: + title: 'Add User to Template | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' + /template/create: + post: tags: - Template - summary: 'Get Template Files as Data Uri' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). - - If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. - operationId: templateFilesAsDataUri - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 + summary: 'Create Template' + description: 'Creates a template that can then be used.' + operationId: templateCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' + examples: + default_example: + $ref: '#/components/examples/TemplateCreateRequestDefaultExample' + form_fields_per_document: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' + form_field_groups: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' + form_field_rules: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' responses: '200': description: 'successful operation' @@ -6467,10 +6516,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/TemplateCreateResponse' examples: default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + $ref: '#/components/examples/TemplateCreateResponseExample' '4XX': description: failed_operation content: @@ -6490,10 +6539,6 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6507,72 +6552,71 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateCreate.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs + $ref: examples/TemplateCreate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateCreate.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateCreate.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateCreate.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateCreate.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateCreate.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateCreate.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_file_url/{template_id}': - get: + title: 'Create Template | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' + /template/create_embedded_draft: + post: tags: - Template - summary: 'Get Template Files as File Url' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). - - If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. - operationId: templateFilesAsFileUrl - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 - - - name: force_download - in: query - description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' - schema: - type: integer - default: 1 + summary: 'Create Embedded Template Draft' + description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' + operationId: templateCreateEmbeddedDraft + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + examples: + default_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' + form_fields_per_document: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' + form_field_groups: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' + form_field_rules: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: '200': description: 'successful operation' @@ -6586,10 +6630,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' '4XX': description: failed_operation content: @@ -6609,10 +6653,6 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6626,58 +6666,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateCreateEmbeddedDraft.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs + $ref: examples/TemplateCreateEmbeddedDraft.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateCreateEmbeddedDraft.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateCreateEmbeddedDraft.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateCreateEmbeddedDraft.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateCreateEmbeddedDraft.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateCreateEmbeddedDraft.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateCreateEmbeddedDraft.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/{template_id}': - get: + title: 'Create Embedded Template Draft | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' + '/template/delete/{template_id}': + post: tags: - Template - summary: 'Get Template' - description: 'Returns the Template specified by the `template_id` parameter.' - operationId: templateGet + summary: 'Delete Template' + description: 'Completely deletes the template specified from the account.' + operationId: templateDelete parameters: - name: template_id in: path - description: 'The id of the Template to retrieve.' + description: 'The id of the Template to delete.' required: true schema: type: string @@ -6693,12 +6733,7 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TemplateGetResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + application/json: {} '4XX': description: failed_operation content: @@ -6716,8 +6751,8 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6731,85 +6766,74 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateDelete.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs + $ref: examples/TemplateDelete.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateDelete.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateDelete.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateDelete.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateDelete.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateDelete.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateDelete.sh x-meta: seo: - title: 'Get Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' - /template/list: + title: 'Delete Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' + '/template/files/{template_id}': get: tags: - Template - summary: 'List Templates' + summary: 'Get Template Files' description: |- - Returns a list of the Templates that are accessible by you. + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. - operationId: templateList + If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + operationId: templateFiles parameters: - - name: account_id - in: query - description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: template_id + in: path + description: 'The id of the template files to retrieve.' + required: true schema: type: string + example: f57db65d3f933b5316d398057a36176831451a35 - - name: page - in: query - description: 'Which page number of the Template List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 - - - name: query + name: file_type in: query - description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + enum: + - pdf + - zip responses: '200': description: 'successful operation' @@ -6821,12 +6845,14 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/TemplateListResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + type: string + format: binary + application/zip: + schema: + type: string + format: binary '4XX': description: failed_operation content: @@ -6842,8 +6868,12 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' + 422_example: + $ref: '#/components/examples/Error422ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: @@ -6859,71 +6889,65 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateFiles.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs + $ref: examples/TemplateFiles.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateList.js + $ref: examples/TemplateFiles.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateFiles.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateFiles.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateFiles.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateFiles.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateFiles.sh x-meta: seo: - title: 'List Templates | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' - '/template/remove_user/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_data_uri/{template_id}': + get: tags: - Template - summary: 'Remove User from Template' - description: 'Removes the specified Account''s access to the specified Template.' - operationId: templateRemoveUser + summary: 'Get Template Files as Data Uri' + description: |- + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + + If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + operationId: templateFilesAsDataUri parameters: - name: template_id in: path - description: 'The id of the Template to remove the Account''s access to.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateRemoveUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: '200': description: 'successful operation' @@ -6937,10 +6961,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + $ref: '#/components/examples/TemplateFilesResponseExample' '4XX': description: failed_operation content: @@ -6958,6 +6982,12 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 422_example: + $ref: '#/components/examples/Error422ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -6971,86 +7001,72 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateFilesAsDataUri.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs + $ref: examples/TemplateFilesAsDataUri.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateFilesAsDataUri.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateFilesAsDataUri.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateFilesAsDataUri.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateFilesAsDataUri.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateFilesAsDataUri.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateFilesAsDataUri.sh x-meta: seo: - title: 'Remove User from Template | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' - '/template/update_files/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_file_url/{template_id}': + get: tags: - Template - summary: 'Update Template Files' + summary: 'Get Template Files as File Url' description: |- - Overlays a new file with the overlay of an existing template. The new file(s) must: - - 1. have the same or higher page count - 2. the same orientation as the file(s) being replaced. - - This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. - - Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. - - It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). - If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). - operationId: templateUpdateFiles + If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + operationId: templateFilesAsFileUrl parameters: - name: template_id in: path - description: 'The ID of the template whose files to update.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' + - + name: force_download + in: query + description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' + schema: + type: integer + default: 1 responses: '200': description: 'successful operation' @@ -7064,10 +7080,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateUpdateFilesResponse' + $ref: '#/components/schemas/FileResponse' examples: default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + $ref: '#/components/examples/TemplateFilesResponseExample' '4XX': description: failed_operation content: @@ -7087,6 +7103,8 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' + 422_example: + $ref: '#/components/examples/Error422ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: @@ -7102,71 +7120,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateFilesAsFileUrl.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs + $ref: examples/TemplateFilesAsFileUrl.cs - lang: JavaScript label: JavaScript source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateFilesAsFileUrl.js - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateFilesAsFileUrl.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateFilesAsFileUrl.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateFilesAsFileUrl.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateFilesAsFileUrl.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateFilesAsFileUrl.sh x-meta: seo: - title: 'Update Template Files | REST API | Dropbox Sign for Developers' - description: 'Overlays a new file with the overlay of an existing template' - /unclaimed_draft/create: - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/{template_id}': + get: tags: - - 'Unclaimed Draft' - summary: 'Create Unclaimed Draft' - description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' - operationId: unclaimedDraftCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + - Template + summary: 'Get Template' + description: 'Returns the Template specified by the `template_id` parameter.' + operationId: templateGet + parameters: + - + name: template_id + in: path + description: 'The id of the Template to retrieve.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 responses: '200': description: 'successful operation' @@ -7180,10 +7189,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + $ref: '#/components/examples/TemplateGetResponseExample' '4XX': description: failed_operation content: @@ -7199,6 +7208,10 @@ paths: $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: @@ -7206,80 +7219,91 @@ paths: api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/TemplateGet.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs + $ref: examples/TemplateGet.cs - lang: JavaScript label: JavaScript source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/TemplateGet.js - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/TemplateGet.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/TemplateGet.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/TemplateGet.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/TemplateGet.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/TemplateGet.sh x-meta: seo: - title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' - /unclaimed_draft/create_embedded: - post: + title: 'Get Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' + /template/list: + get: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft' + - Template + summary: 'List Templates' description: |- - Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. + Returns a list of the Templates that are accessible by you. - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftCreateEmbedded - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + operationId: templateList + parameters: + - + name: account_id + in: query + description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the Template List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + schema: + type: string responses: '200': description: 'successful operation' @@ -7293,10 +7317,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateListResponse' examples: default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + $ref: '#/components/examples/TemplateListResponseExample' '4XX': description: failed_operation content: @@ -7312,10 +7336,10 @@ paths: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -7323,75 +7347,77 @@ paths: api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/TemplateList.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs + $ref: examples/TemplateList.cs - lang: JavaScript label: JavaScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/TemplateList.js - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/TemplateList.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/TemplateList.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/TemplateList.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/TemplateList.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/TemplateList.sh x-meta: seo: - title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' - /unclaimed_draft/create_embedded_with_template: + title: 'List Templates | API Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' + '/template/remove_user/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft with Template' - description: |- - Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. - - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftCreateEmbeddedWithTemplate + - Template + summary: 'Remove User from Template' + description: 'Removes the specified Account''s access to the specified Template.' + operationId: templateRemoveUser + parameters: + - + name: template_id + in: path + description: 'The id of the Template to remove the Account''s access to.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: '200': description: 'successful operation' @@ -7405,10 +7431,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + $ref: '#/components/examples/TemplateRemoveUserResponseExample' '4XX': description: failed_operation content: @@ -7426,10 +7452,6 @@ paths: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -7437,80 +7459,92 @@ paths: api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/TemplateRemoveUser.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs + $ref: examples/TemplateRemoveUser.cs - lang: JavaScript label: JavaScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/TemplateRemoveUser.js - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/TemplateRemoveUser.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/TemplateRemoveUser.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/TemplateRemoveUser.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/TemplateRemoveUser.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/TemplateRemoveUser.sh x-meta: seo: - title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' - '/unclaimed_draft/edit_and_resend/{signature_request_id}': + title: 'Remove User from Template | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' + '/template/update_files/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Edit and Resend Unclaimed Draft' + - Template + summary: 'Update Template Files' description: |- - Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. + Overlays a new file with the overlay of an existing template. The new file(s) must: - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftEditAndResend + 1. have the same or higher page count + 2. the same orientation as the file(s) being replaced. + + This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. + + Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. + + It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. + + If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + operationId: templateUpdateFiles parameters: - - name: signature_request_id + name: template_id in: path - description: 'The ID of the signature request to edit and resend.' + description: 'The ID of the template whose files to update.' required: true schema: type: string - example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: '200': description: 'successful operation' @@ -7524,10 +7558,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + $ref: '#/components/examples/TemplateUpdateFilesResponseExample' '4XX': description: failed_operation content: @@ -7547,8 +7581,118 @@ paths: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - template_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/TemplateUpdateFiles.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/TemplateUpdateFiles.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/TemplateUpdateFiles.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/TemplateUpdateFiles.ts + - + lang: Java + label: Java + source: + $ref: examples/TemplateUpdateFiles.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/TemplateUpdateFiles.rb + - + lang: Python + label: Python + source: + $ref: examples/TemplateUpdateFiles.py + - + lang: cURL + label: cURL + source: + $ref: examples/TemplateUpdateFiles.sh + x-meta: + seo: + title: 'Update Template Files | REST API | Dropbox Sign for Developers' + description: 'Overlays a new file with the overlay of an existing template' + /unclaimed_draft/create: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Unclaimed Draft' + description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' + operationId: unclaimedDraftCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' + form_fields_per_document: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' + form_field_groups: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' + form_field_rules: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + 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/UnclaimedDraftCreateResponse' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + '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: @@ -7556,97 +7700,447 @@ paths: api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftCreate.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs + $ref: examples/UnclaimedDraftCreate.cs - lang: JavaScript label: JavaScript source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftCreate.js - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftCreate.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftCreate.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftCreate.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftCreate.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftCreate.sh x-meta: seo: - title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' -components: - schemas: - AccountCreateRequest: - required: - - email_address - properties: - client_id: - description: |- - Used when creating a new account with OAuth authorization. - - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - client_secret: - description: |- - Used when creating a new account with OAuth authorization. + title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' + /unclaimed_draft/create_embedded: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft' + description: |- + Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - email_address: - description: 'The email address which will be associated with the new Account.' - type: string - format: email - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountUpdateRequest: - properties: - account_id: - description: 'The ID of the Account' - type: string - nullable: true - callback_url: - description: 'The URL that Dropbox Sign should POST events to.' - type: string - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountVerifyRequest: - required: - - email_address - properties: - email_address: + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbedded + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' + form_fields_per_document: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' + form_field_groups: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' + form_field_rules: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + 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/UnclaimedDraftCreateResponse' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + '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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbedded.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbedded.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/UnclaimedDraftCreateEmbedded.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbedded.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbedded.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbedded.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbedded.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbedded.sh + x-meta: + seo: + title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' + /unclaimed_draft/create_embedded_with_template: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft with Template' + description: |- + Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. + + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbeddedWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + 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/UnclaimedDraftCreateResponse' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + '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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + x-meta: + seo: + title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' + '/unclaimed_draft/edit_and_resend/{signature_request_id}': + post: + tags: + - 'Unclaimed Draft' + summary: 'Edit and Resend Unclaimed Draft' + description: |- + Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. + + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftEditAndResend + parameters: + - + name: signature_request_id + in: path + description: 'The ID of the signature request to edit and resend.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + 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/UnclaimedDraftCreateResponse' + examples: + default_example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + '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' + 409_example: + $ref: '#/components/examples/Error409ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftEditAndResend.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftEditAndResend.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/UnclaimedDraftEditAndResend.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftEditAndResend.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftEditAndResend.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftEditAndResend.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftEditAndResend.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftEditAndResend.sh + x-meta: + seo: + title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' +components: + schemas: + AccountCreateRequest: + required: + - email_address + properties: + client_id: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + client_secret: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + email_address: + description: 'The email address which will be associated with the new Account.' + type: string + format: email + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountUpdateRequest: + properties: + account_id: + description: 'The ID of the Account' + type: string + nullable: true + callback_url: + description: 'The URL that Dropbox Sign should POST events to.' + type: string + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountVerifyRequest: + required: + - email_address + properties: + email_address: description: 'Email address to run the verification for.' type: string format: email @@ -7862,6 +8356,10 @@ components: - US - UK x-enum-varnames-override: + csharp: + - CA + - US + - UK typescript-node: - Ca - Us @@ -8003,23 +8501,112 @@ components: end_date: description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.' type: string - report_type: - description: 'The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).' - type: array - items: - type: string - enum: - - user_activity - - document_status - maxItems: 2 - minItems: 1 - start_date: - description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.' + report_type: + description: 'The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).' + type: array + items: + type: string + enum: + - user_activity + - document_status + maxItems: 2 + minItems: 1 + start_date: + description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.' + type: string + type: object + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + signer_file: + description: |- + `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: + + - `name`: the name of the signer filling the role of RoleName + - `email_address`: email address of the signer filling the role of RoleName + - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) + - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) + + By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). + + **NOTE:** Not available in test mode and requires a Standard plan or higher. + - `*_field`: any column with a _field" suffix will be treated as a custom field (optional) + + You may only specify field values here, any other options should be set in the custom_fields request parameter. + + Example CSV: + + ``` + name, email_address, pin, company_field + George, george@example.com, d79a3td, ABC Corp + Mary, mary@example.com, gd9as5b, 123 LLC + ``` + type: string + format: binary + signer_list: + description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + type: array + items: + $ref: '#/components/schemas/SubBulkSignerList' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' type: string + maxLength: 255 type: object - SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + SignatureRequestBulkSendWithTemplateRequest: required: - - client_id - template_ids properties: template_ids: @@ -8066,19 +8653,244 @@ components: type: array items: $ref: '#/components/schemas/SubCC' + client_id: + description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object + SignatureRequestCreateEmbeddedRequest: + required: + - client_id + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + + **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + populate_auto_fill_fields: + description: |- + Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + + **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true + type: object + SignatureRequestCreateEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + - signers + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' client_id: description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' type: string custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: description: |- - When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. - - Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: - $ref: '#/components/schemas/SubCustomField' + type: string message: description: 'The custom message in the email that will be sent to the signers.' type: string @@ -8091,9 +8903,13 @@ components: type: object maxItems: 10 additionalProperties: {} - signing_redirect_url: - description: 'The URL you want signers redirected to after they successfully sign.' - type: string + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' subject: description: 'The subject in the email that will be sent to the signers.' type: string @@ -8106,55 +8922,71 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + populate_auto_fill_fields: + description: |- + Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + + **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + type: boolean + default: false type: object - SignatureRequestBulkSendWithTemplateRequest: - required: - - template_ids + SignatureRequestEditRequest: properties: - template_ids: - description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string - signer_file: + format: binary + file_urls: description: |- - `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - - - `name`: the name of the signer filling the role of RoleName - - `email_address`: email address of the signer filling the role of RoleName - - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. - - `*_field`: any column with a _field" suffix will be treated as a custom field (optional) + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. - You may only specify field values here, any other options should be set in the custom_fields request parameter. + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. - Example CSV: + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. - ``` - name, email_address, pin, company_field - George, george@example.com, d79a3td, ABC Corp - Mary, mary@example.com, gd9as5b, 123 LLC - ``` - type: string - format: binary - signer_list: - description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: - $ref: '#/components/schemas/SubBulkSignerList' + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - ccs: - description: 'Add CC email recipients. Required when a CC role exists for the Template.' + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan and higher. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' type: array items: - $ref: '#/components/schemas/SubCC' + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email client_id: description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' type: string @@ -8168,6 +9000,52 @@ components: type: array items: $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + + **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string @@ -8180,6 +9058,8 @@ components: type: object maxItems: 10 additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string @@ -8195,8 +9075,16 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true type: object - SignatureRequestCreateEmbeddedRequest: + SignatureRequestEditEmbeddedRequest: required: - client_id properties: @@ -8348,7 +9236,7 @@ components: type: integer nullable: true type: object - SignatureRequestCreateEmbeddedWithTemplateRequest: + SignatureRequestEditEmbeddedWithTemplateRequest: required: - client_id - template_ids @@ -8432,6 +9320,94 @@ components: type: boolean default: false type: object + SignatureRequestEditWithTemplateRequest: + description: '' + required: + - signers + - template_ids + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object SignatureRequestRemindRequest: required: - email_address @@ -8945,6 +9921,9 @@ components: csharp: - FieldVisibility - GroupVisibility + java: + - FIELD_VISIBILITY + - GROUP_VISIBILITY php: - TYPE_FIELD_VISIBILITY - TYPE_GROUP_VISIBILITY @@ -13190,6 +14169,30 @@ components: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json + SignatureRequestEditRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditRequestDefaultExample.json + SignatureRequestEditRequestGroupedSignersExample: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json + SignatureRequestEditEmbeddedRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json + SignatureRequestEditEmbeddedRequestGroupedSignersExample: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json + SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json + SignatureRequestEditWithTemplateRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json SignatureRequestRemindRequestDefaultExample: summary: 'Default Example' value: diff --git a/openapi.yaml b/openapi.yaml index 7baa54892..5643bcbfb 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1826,7 +1826,6 @@ paths: - CA - US - UK - example: US - name: state in: query @@ -2108,7 +2107,6 @@ paths: required: true schema: type: string - example: '[FAX_NUMBER]' responses: '200': description: 'successful operation' @@ -7862,6 +7860,10 @@ components: - US - UK x-enum-varnames-override: + csharp: + - CA + - US + - UK typescript-node: - Ca - Us @@ -8432,6 +8434,484 @@ components: type: boolean default: false type: object + SignatureRequestEditRequest: + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan and higher. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email + client_id: + description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + + **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true + type: object + SignatureRequestEditEmbeddedRequest: + required: + - client_id + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) + + **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + populate_auto_fill_fields: + description: |- + Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + + **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true + type: object + SignatureRequestEditEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + - signers + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + populate_auto_fill_fields: + description: |- + Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. + + **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + type: boolean + default: false + type: object + SignatureRequestEditWithTemplateRequest: + description: '' + required: + - signers + - template_ids + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object SignatureRequestRemindRequest: required: - email_address @@ -8923,6 +9403,9 @@ components: csharp: - FieldVisibility - GroupVisibility + java: + - FIELD_VISIBILITY + - GROUP_VISIBILITY php: - TYPE_FIELD_VISIBILITY - TYPE_GROUP_VISIBILITY @@ -13168,6 +13651,30 @@ components: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json + SignatureRequestEditRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditRequestDefaultExample.json + SignatureRequestEditRequestGroupedSignersExample: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json + SignatureRequestEditEmbeddedRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json + SignatureRequestEditEmbeddedRequestGroupedSignersExample: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json + SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json + SignatureRequestEditWithTemplateRequestDefaultExample: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json SignatureRequestRemindRequestDefaultExample: summary: 'Default Example' value: diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index 104db3486..fcea11bde 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -161,6 +161,10 @@ Class | Method | HTTP request | Description *SignatureRequestApi* | [**SignatureRequestCancel**](docs/SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request *SignatureRequestApi* | [**SignatureRequestCreateEmbedded**](docs/SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request *SignatureRequestApi* | [**SignatureRequestCreateEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +*SignatureRequestApi* | [**SignatureRequestEdit**](docs/SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +*SignatureRequestApi* | [**SignatureRequestEditEmbedded**](docs/SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +*SignatureRequestApi* | [**SignatureRequestEditEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +*SignatureRequestApi* | [**SignatureRequestEditWithTemplate**](docs/SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template *SignatureRequestApi* | [**SignatureRequestFiles**](docs/SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files *SignatureRequestApi* | [**SignatureRequestFilesAsDataUri**](docs/SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri *SignatureRequestApi* | [**SignatureRequestFilesAsFileUrl**](docs/SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -265,6 +269,10 @@ Class | Method | HTTP request | Description - [Model.SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [Model.SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [Model.SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [Model.SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [Model.SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [Model.SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [Model.SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [Model.SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [Model.SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [Model.SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) diff --git a/sdks/dotnet/docs/SignatureRequestApi.md b/sdks/dotnet/docs/SignatureRequestApi.md index a507cc08f..4e5f19d8e 100644 --- a/sdks/dotnet/docs/SignatureRequestApi.md +++ b/sdks/dotnet/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3* | [**SignatureRequestCancel**](SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | | [**SignatureRequestCreateEmbedded**](SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | | [**SignatureRequestCreateEmbeddedWithTemplate**](SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +| [**SignatureRequestEdit**](SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +| [**SignatureRequestEditEmbedded**](SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +| [**SignatureRequestEditEmbeddedWithTemplate**](SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +| [**SignatureRequestEditWithTemplate**](SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | | [**SignatureRequestFiles**](SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files | | [**SignatureRequestFilesAsDataUri**](SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | | [**SignatureRequestFilesAsFileUrl**](SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -641,6 +645,551 @@ catch (ApiException e) - **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) + + +# **SignatureRequestEdit** +> SignatureRequestGetResponse SignatureRequestEdit (string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + +### 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(); + // Configure HTTP basic authorization: api_key + config.Username = "YOUR_API_KEY"; + + // or, configure Bearer (JWT) authorization: oauth2 + // config.AccessToken = "YOUR_BEARER_TOKEN"; + + var signatureRequestApi = new SignatureRequestApi(config); + + var signer1 = new SubSignatureRequestSigner( + emailAddress: "jack@example.com", + name: "Jack", + order: 0 + ); + + var signer2 = new SubSignatureRequestSigner( + emailAddress: "jill@example.com", + name: "Jill", + order: 1 + ); + + var signingOptions = new SubSigningOptions( + draw: true, + type: true, + upload: true, + phone: true, + defaultType: SubSigningOptions.DefaultTypeEnum.Draw + ); + + var subFieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY + ); + + var metadata = new Dictionary() + { + ["custom_id"] = 1234, + ["custom_text"] = "NDA #9" + }; + + var files = new List { + new FileStream( + "./example_signature_request.pdf", + FileMode.Open, + FileAccess.Read, + FileShare.Read + ) + }; + + var data = new SignatureRequestEditRequest( + title: "NDA with Acme Co.", + subject: "The NDA we talked about", + message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers: new List(){signer1, signer2}, + ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, + files: files, + metadata: metadata, + signingOptions: signingOptions, + fieldOptions: subFieldOptions, + testMode: true + ); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + try + { + var result = signatureRequestApi.SignatureRequestEdit(signatureRequestId, 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 SignatureRequestEditWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Edit Signature Request + ApiResponse response = apiInstance.SignatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest); + 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 SignatureRequestApi.SignatureRequestEditWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | | +| **signatureRequestEditRequest** | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + + +# **SignatureRequestEditEmbedded** +> SignatureRequestGetResponse SignatureRequestEditEmbedded (string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) + +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### 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(); + // Configure HTTP basic authorization: api_key + config.Username = "YOUR_API_KEY"; + + // or, configure Bearer (JWT) authorization: oauth2 + // config.AccessToken = "YOUR_BEARER_TOKEN"; + + var signatureRequestApi = new SignatureRequestApi(config); + + var signer1 = new SubSignatureRequestSigner( + emailAddress: "jack@example.com", + name: "Jack", + order: 0 + ); + + var signer2 = new SubSignatureRequestSigner( + emailAddress: "jill@example.com", + name: "Jill", + order: 1 + ); + + var signingOptions = new SubSigningOptions( + draw: true, + type: true, + upload: true, + phone: true, + defaultType: SubSigningOptions.DefaultTypeEnum.Draw + ); + + var files = new List { + new FileStream( + "./example_signature_request.pdf", + FileMode.Open, + FileAccess.Read, + FileShare.Read + ) + }; + + var data = new SignatureRequestEditEmbeddedRequest( + clientId: "ec64a202072370a737edf4a0eb7f4437", + title: "NDA with Acme Co.", + subject: "The NDA we talked about", + message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers: new List(){signer1, signer2}, + ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, + files: files, + signingOptions: signingOptions, + testMode: true + ); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + try + { + var result = signatureRequestApi.SignatureRequestEditEmbedded( + signatureRequestId, + 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 SignatureRequestEditEmbeddedWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Edit Embedded Signature Request + ApiResponse response = apiInstance.SignatureRequestEditEmbeddedWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedRequest); + 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 SignatureRequestApi.SignatureRequestEditEmbeddedWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | | +| **signatureRequestEditEmbeddedRequest** | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + + +# **SignatureRequestEditEmbeddedWithTemplate** +> SignatureRequestGetResponse SignatureRequestEditEmbeddedWithTemplate (string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) + +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example +```csharp +using System; +using System.Collections.Generic; +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"; + + // or, configure Bearer (JWT) authorization: oauth2 + // config.AccessToken = "YOUR_BEARER_TOKEN"; + + var signatureRequestApi = new SignatureRequestApi(config); + + var signer1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George" + ); + + var subSigningOptions = new SubSigningOptions( + draw: true, + type: true, + upload: true, + phone: false, + defaultType: SubSigningOptions.DefaultTypeEnum.Draw + ); + + var data = new SignatureRequestEditEmbeddedWithTemplateRequest( + clientId: "ec64a202072370a737edf4a0eb7f4437", + templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, + subject: "Purchase Order", + message: "Glad we could come to an agreement.", + signers: new List(){signer1}, + signingOptions: subSigningOptions, + testMode: true + ); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + try + { + var result = signatureRequestApi.SignatureRequestEditEmbeddedWithTemplate( + signatureRequestId, + 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 SignatureRequestEditEmbeddedWithTemplateWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Edit Embedded Signature Request with Template + ApiResponse response = apiInstance.SignatureRequestEditEmbeddedWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest); + 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 SignatureRequestApi.SignatureRequestEditEmbeddedWithTemplateWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | | +| **signatureRequestEditEmbeddedWithTemplateRequest** | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + + +# **SignatureRequestEditWithTemplate** +> SignatureRequestGetResponse SignatureRequestEditWithTemplate (string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Example +```csharp +using System; +using System.Collections.Generic; +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"; + + // or, configure Bearer (JWT) authorization: oauth2 + // config.AccessToken = "YOUR_BEARER_TOKEN"; + + var signatureRequestApi = new SignatureRequestApi(config); + + var signer1 = new SubSignatureRequestTemplateSigner( + role: "Client", + emailAddress: "george@example.com", + name: "George" + ); + + var cc1 = new SubCC( + role: "Accounting", + emailAddress: "accouting@emaple.com" + ); + + var customField1 = new SubCustomField( + name: "Cost", + value: "$20,000", + editor: "Client", + required: true + ); + + var signingOptions = new SubSigningOptions( + draw: true, + type: true, + upload: true, + phone: false, + defaultType: SubSigningOptions.DefaultTypeEnum.Draw + ); + + var data = new SignatureRequestEditWithTemplateRequest( + templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, + subject: "Purchase Order", + message: "Glad we could come to an agreement.", + signers: new List(){signer1}, + ccs: new List(){cc1}, + customFields: new List(){customField1}, + signingOptions: signingOptions, + testMode: true + ); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + try + { + var result = signatureRequestApi.SignatureRequestEditWithTemplate(signatureRequestId, 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 SignatureRequestEditWithTemplateWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Edit Signature Request With Template + ApiResponse response = apiInstance.SignatureRequestEditWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditWithTemplateRequest); + 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 SignatureRequestApi.SignatureRequestEditWithTemplateWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | | +| **signatureRequestEditWithTemplateRequest** | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..3d7e41773 --- /dev/null +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.SignatureRequestEditEmbeddedRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [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/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..8be8d1b17 --- /dev/null +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.SignatureRequestEditEmbeddedWithTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] + +[[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/sdks/dotnet/docs/SignatureRequestEditRequest.md b/sdks/dotnet/docs/SignatureRequestEditRequest.md new file mode 100644 index 000000000..20f216403 --- /dev/null +++ b/sdks/dotnet/docs/SignatureRequestEditRequest.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.SignatureRequestEditRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [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/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..d9ac882ee --- /dev/null +++ b/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.SignatureRequestEditWithTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [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/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs index 7671b5780..71c7ec8b1 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs @@ -143,6 +143,106 @@ public interface ISignatureRequestApiSync : IApiAccessor /// ApiResponse of SignatureRequestGetResponse ApiResponse SignatureRequestCreateEmbeddedWithTemplateWithHttpInfo(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest, int operationIndex = 0); /// + /// Edit Signature Request + /// + /// + /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + SignatureRequestGetResponse SignatureRequestEdit(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0); + + /// + /// Edit Signature Request + /// + /// + /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + ApiResponse SignatureRequestEditWithHttpInfo(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0); + /// + /// Edit Embedded Signature Request + /// + /// + /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + SignatureRequestGetResponse SignatureRequestEditEmbedded(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0); + + /// + /// Edit Embedded Signature Request + /// + /// + /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + ApiResponse SignatureRequestEditEmbeddedWithHttpInfo(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0); + /// + /// Edit Embedded Signature Request with Template + /// + /// + /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + SignatureRequestGetResponse SignatureRequestEditEmbeddedWithTemplate(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0); + + /// + /// Edit Embedded Signature Request with Template + /// + /// + /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + ApiResponse SignatureRequestEditEmbeddedWithTemplateWithHttpInfo(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0); + /// + /// Edit Signature Request With Template + /// + /// + /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + SignatureRequestGetResponse SignatureRequestEditWithTemplate(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0); + + /// + /// Edit Signature Request With Template + /// + /// + /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + ApiResponse SignatureRequestEditWithTemplateWithHttpInfo(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0); + /// /// Download Files /// /// @@ -544,6 +644,114 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// Task of ApiResponse (SignatureRequestGetResponse) System.Threading.Tasks.Task> SignatureRequestCreateEmbeddedWithTemplateWithHttpInfoAsync(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// + /// Edit Signature Request + /// + /// + /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + System.Threading.Tasks.Task SignatureRequestEditAsync(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Edit Signature Request + /// + /// + /// Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + System.Threading.Tasks.Task> SignatureRequestEditWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// Edit Embedded Signature Request + /// + /// + /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + System.Threading.Tasks.Task SignatureRequestEditEmbeddedAsync(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Edit Embedded Signature Request + /// + /// + /// Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + System.Threading.Tasks.Task> SignatureRequestEditEmbeddedWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// Edit Embedded Signature Request with Template + /// + /// + /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + System.Threading.Tasks.Task SignatureRequestEditEmbeddedWithTemplateAsync(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Edit Embedded Signature Request with Template + /// + /// + /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + System.Threading.Tasks.Task> SignatureRequestEditEmbeddedWithTemplateWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// Edit Signature Request With Template + /// + /// + /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + System.Threading.Tasks.Task SignatureRequestEditWithTemplateAsync(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Edit Signature Request With Template + /// + /// + /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + System.Threading.Tasks.Task> SignatureRequestEditWithTemplateWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// /// Download Files /// /// @@ -1842,6 +2050,814 @@ public Dropbox.Sign.Client.ApiResponse SignatureReq return localVarResponse; } + /// + /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + public SignatureRequestGetResponse SignatureRequestEdit(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = SignatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest); + return localVarResponse.Data; + } + + /// + /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + public Dropbox.Sign.Client.ApiResponse SignatureRequestEditWithHttpInfo(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEdit"); + } + + // verify the required parameter 'signatureRequestEditRequest' is set + if (signatureRequestEditRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditRequest' when calling SignatureRequestApi->SignatureRequestEdit"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEdit"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = this.Client.Put("/signature_request/edit/{signature_request_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEdit", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + public async System.Threading.Tasks.Task SignatureRequestEditAsync(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await SignatureRequestEditWithHttpInfoAsync(signatureRequestId, signatureRequestEditRequest, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Edit Signature Request Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + public async System.Threading.Tasks.Task> SignatureRequestEditWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEdit"); + } + + // verify the required parameter 'signatureRequestEditRequest' is set + if (signatureRequestEditRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditRequest' when calling SignatureRequestApi->SignatureRequestEdit"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEdit"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PutAsync("/signature_request/edit/{signature_request_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEdit", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + public SignatureRequestGetResponse SignatureRequestEditEmbedded(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = SignatureRequestEditEmbeddedWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedRequest); + return localVarResponse.Data; + } + + /// + /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + public Dropbox.Sign.Client.ApiResponse SignatureRequestEditEmbeddedWithHttpInfo(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEditEmbedded"); + } + + // verify the required parameter 'signatureRequestEditEmbeddedRequest' is set + if (signatureRequestEditEmbeddedRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditEmbeddedRequest' when calling SignatureRequestApi->SignatureRequestEditEmbedded"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditEmbeddedRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditEmbeddedRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEditEmbedded"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = this.Client.Put("/signature_request/edit_embedded/{signature_request_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEditEmbedded", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + public async System.Threading.Tasks.Task SignatureRequestEditEmbeddedAsync(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await SignatureRequestEditEmbeddedWithHttpInfoAsync(signatureRequestId, signatureRequestEditEmbeddedRequest, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Edit Embedded Signature Request Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + public async System.Threading.Tasks.Task> SignatureRequestEditEmbeddedWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEditEmbedded"); + } + + // verify the required parameter 'signatureRequestEditEmbeddedRequest' is set + if (signatureRequestEditEmbeddedRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditEmbeddedRequest' when calling SignatureRequestApi->SignatureRequestEditEmbedded"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditEmbeddedRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditEmbeddedRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEditEmbedded"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PutAsync("/signature_request/edit_embedded/{signature_request_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEditEmbedded", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + public SignatureRequestGetResponse SignatureRequestEditEmbeddedWithTemplate(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = SignatureRequestEditEmbeddedWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest); + return localVarResponse.Data; + } + + /// + /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + public Dropbox.Sign.Client.ApiResponse SignatureRequestEditEmbeddedWithTemplateWithHttpInfo(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEditEmbeddedWithTemplate"); + } + + // verify the required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' is set + if (signatureRequestEditEmbeddedWithTemplateRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' when calling SignatureRequestApi->SignatureRequestEditEmbeddedWithTemplate"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditEmbeddedWithTemplateRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditEmbeddedWithTemplateRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEditEmbeddedWithTemplate"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = this.Client.Put("/signature_request/edit_embedded_with_template/{signature_request_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEditEmbeddedWithTemplate", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + public async System.Threading.Tasks.Task SignatureRequestEditEmbeddedWithTemplateAsync(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await SignatureRequestEditEmbeddedWithTemplateWithHttpInfoAsync(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Edit Embedded Signature Request with Template Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + public async System.Threading.Tasks.Task> SignatureRequestEditEmbeddedWithTemplateWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEditEmbeddedWithTemplate"); + } + + // verify the required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' is set + if (signatureRequestEditEmbeddedWithTemplateRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' when calling SignatureRequestApi->SignatureRequestEditEmbeddedWithTemplate"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditEmbeddedWithTemplateRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditEmbeddedWithTemplateRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEditEmbeddedWithTemplate"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PutAsync("/signature_request/edit_embedded_with_template/{signature_request_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEditEmbeddedWithTemplate", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// SignatureRequestGetResponse + public SignatureRequestGetResponse SignatureRequestEditWithTemplate(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = SignatureRequestEditWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditWithTemplateRequest); + return localVarResponse.Data; + } + + /// + /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// ApiResponse of SignatureRequestGetResponse + public Dropbox.Sign.Client.ApiResponse SignatureRequestEditWithTemplateWithHttpInfo(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEditWithTemplate"); + } + + // verify the required parameter 'signatureRequestEditWithTemplateRequest' is set + if (signatureRequestEditWithTemplateRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditWithTemplateRequest' when calling SignatureRequestApi->SignatureRequestEditWithTemplate"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditWithTemplateRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditWithTemplateRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEditWithTemplate"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = this.Client.Put("/signature_request/edit_with_template/{signature_request_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEditWithTemplate", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of SignatureRequestGetResponse + public async System.Threading.Tasks.Task SignatureRequestEditWithTemplateAsync(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await SignatureRequestEditWithTemplateWithHttpInfoAsync(signatureRequestId, signatureRequestEditWithTemplateRequest, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Edit Signature Request With Template Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + /// + /// Thrown when fails to make API call + /// The id of the SignatureRequest to edit. + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SignatureRequestGetResponse) + public async System.Threading.Tasks.Task> SignatureRequestEditWithTemplateWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'signatureRequestId' is set + if (signatureRequestId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestId' when calling SignatureRequestApi->SignatureRequestEditWithTemplate"); + } + + // verify the required parameter 'signatureRequestEditWithTemplateRequest' is set + if (signatureRequestEditWithTemplateRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'signatureRequestEditWithTemplateRequest' when calling SignatureRequestApi->SignatureRequestEditWithTemplate"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = signatureRequestEditWithTemplateRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = signatureRequestEditWithTemplateRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("signature_request_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(signatureRequestId)); // path parameter + + localVarRequestOptions.Operation = "SignatureRequestApi.SignatureRequestEditWithTemplate"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + // authentication (oauth2) required + // bearer authentication required + if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PutAsync("/signature_request/edit_with_template/{signature_request_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("SignatureRequestEditWithTemplate", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + /// /// Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs new file mode 100644 index 000000000..68a03290b --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs @@ -0,0 +1,772 @@ +/* + * 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; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// SignatureRequestEditEmbeddedRequest + /// + [DataContract(Name = "SignatureRequestEditEmbeddedRequest")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SignatureRequestEditEmbeddedRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SignatureRequestEditEmbeddedRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. (default to false). + /// A list describing the attachments. + /// The email addresses that should be CCed.. + /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). + /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. + /// fieldOptions. + /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.. + /// Conditional Logic rules for fields defined in `form_fields_per_document`.. + /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. + /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). + /// The custom message in the email that will be sent to the signers.. + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// signingOptions. + /// The subject in the email that will be sent to the signers.. + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). + /// The title you want to assign to the SignatureRequest.. + /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). + /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). + /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. + public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + { + + // to ensure "clientId" is required (not null) + if (clientId == null) + { + throw new ArgumentNullException("clientId is a required property for SignatureRequestEditEmbeddedRequest and cannot be null"); + } + this.ClientId = clientId; + this.Files = files; + this.FileUrls = fileUrls; + this.Signers = signers; + this.GroupedSigners = groupedSigners; + this.AllowDecline = allowDecline; + this.AllowReassign = allowReassign; + this.Attachments = attachments; + this.CcEmailAddresses = ccEmailAddresses; + this.CustomFields = customFields; + this.FieldOptions = fieldOptions; + this.FormFieldGroups = formFieldGroups; + this.FormFieldRules = formFieldRules; + this.FormFieldsPerDocument = formFieldsPerDocument; + this.HideTextTags = hideTextTags; + this.Message = message; + this.Metadata = metadata; + this.SigningOptions = signingOptions; + this.Subject = subject; + this.TestMode = testMode; + this.Title = title; + this.UseTextTags = useTextTags; + this.PopulateAutoFillFields = populateAutoFillFields; + this.ExpiresAt = expiresAt; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SignatureRequestEditEmbeddedRequest Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditEmbeddedRequest"); + } + + return obj; + } + + /// + /// Client id of the app you're using to create this embedded signature request. Used for security purposes. + /// + /// Client id of the app you're using to create this embedded signature request. Used for security purposes. + [DataMember(Name = "client_id", IsRequired = true, EmitDefaultValue = true)] + public string ClientId { get; set; } + + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "files", EmitDefaultValue = true)] + public List Files { get; set; } + + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "file_urls", EmitDefaultValue = true)] + public List FileUrls { get; set; } + + /// + /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// + /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + [DataMember(Name = "signers", EmitDefaultValue = true)] + public List Signers { get; set; } + + /// + /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// + /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] + public List GroupedSigners { get; set; } + + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + [DataMember(Name = "allow_decline", EmitDefaultValue = true)] + public bool AllowDecline { get; set; } + + /// + /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + /// + /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] + public bool AllowReassign { get; set; } + + /// + /// A list describing the attachments + /// + /// A list describing the attachments + [DataMember(Name = "attachments", EmitDefaultValue = true)] + public List Attachments { get; set; } + + /// + /// The email addresses that should be CCed. + /// + /// The email addresses that should be CCed. + [DataMember(Name = "cc_email_addresses", EmitDefaultValue = true)] + public List CcEmailAddresses { get; set; } + + /// + /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + /// + /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + [DataMember(Name = "custom_fields", EmitDefaultValue = true)] + public List CustomFields { get; set; } + + /// + /// Gets or Sets FieldOptions + /// + [DataMember(Name = "field_options", EmitDefaultValue = true)] + public SubFieldOptions FieldOptions { get; set; } + + /// + /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + /// + /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + [DataMember(Name = "form_field_groups", EmitDefaultValue = true)] + public List FormFieldGroups { get; set; } + + /// + /// Conditional Logic rules for fields defined in `form_fields_per_document`. + /// + /// Conditional Logic rules for fields defined in `form_fields_per_document`. + [DataMember(Name = "form_field_rules", EmitDefaultValue = true)] + public List FormFieldRules { get; set; } + + /// + /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + /// + /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + [DataMember(Name = "form_fields_per_document", EmitDefaultValue = true)] + public List FormFieldsPerDocument { get; set; } + + /// + /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + /// + /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + [DataMember(Name = "hide_text_tags", EmitDefaultValue = true)] + public bool HideTextTags { get; set; } + + /// + /// The custom message in the email that will be sent to the signers. + /// + /// The custom message in the email that will be sent to the signers. + [DataMember(Name = "message", EmitDefaultValue = true)] + public string Message { get; set; } + + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + [DataMember(Name = "metadata", EmitDefaultValue = true)] + public Dictionary Metadata { get; set; } + + /// + /// Gets or Sets SigningOptions + /// + [DataMember(Name = "signing_options", EmitDefaultValue = true)] + public SubSigningOptions SigningOptions { get; set; } + + /// + /// The subject in the email that will be sent to the signers. + /// + /// The subject in the email that will be sent to the signers. + [DataMember(Name = "subject", EmitDefaultValue = true)] + public string Subject { get; set; } + + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + [DataMember(Name = "test_mode", EmitDefaultValue = true)] + public bool TestMode { get; set; } + + /// + /// The title you want to assign to the SignatureRequest. + /// + /// The title you want to assign to the SignatureRequest. + [DataMember(Name = "title", EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + /// + /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] + public bool UseTextTags { get; set; } + + /// + /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + /// + /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] + public bool PopulateAutoFillFields { get; set; } + + /// + /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + /// + /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + [DataMember(Name = "expires_at", EmitDefaultValue = true)] + public int? ExpiresAt { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SignatureRequestEditEmbeddedRequest {\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" Files: ").Append(Files).Append("\n"); + sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); + sb.Append(" Signers: ").Append(Signers).Append("\n"); + sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); + sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); + sb.Append(" Attachments: ").Append(Attachments).Append("\n"); + sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); + sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); + sb.Append(" FieldOptions: ").Append(FieldOptions).Append("\n"); + sb.Append(" FormFieldGroups: ").Append(FormFieldGroups).Append("\n"); + sb.Append(" FormFieldRules: ").Append(FormFieldRules).Append("\n"); + sb.Append(" FormFieldsPerDocument: ").Append(FormFieldsPerDocument).Append("\n"); + sb.Append(" HideTextTags: ").Append(HideTextTags).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); + sb.Append(" Subject: ").Append(Subject).Append("\n"); + sb.Append(" TestMode: ").Append(TestMode).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); + sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SignatureRequestEditEmbeddedRequest); + } + + /// + /// Returns true if SignatureRequestEditEmbeddedRequest instances are equal + /// + /// Instance of SignatureRequestEditEmbeddedRequest to be compared + /// Boolean + public bool Equals(SignatureRequestEditEmbeddedRequest input) + { + if (input == null) + { + return false; + } + return + ( + this.ClientId == input.ClientId || + (this.ClientId != null && + this.ClientId.Equals(input.ClientId)) + ) && + ( + this.Files == input.Files || + this.Files != null && + input.Files != null && + this.Files.SequenceEqual(input.Files) + ) && + ( + this.FileUrls == input.FileUrls || + this.FileUrls != null && + input.FileUrls != null && + this.FileUrls.SequenceEqual(input.FileUrls) + ) && + ( + this.Signers == input.Signers || + this.Signers != null && + input.Signers != null && + this.Signers.SequenceEqual(input.Signers) + ) && + ( + this.GroupedSigners == input.GroupedSigners || + this.GroupedSigners != null && + input.GroupedSigners != null && + this.GroupedSigners.SequenceEqual(input.GroupedSigners) + ) && + ( + this.AllowDecline == input.AllowDecline || + this.AllowDecline.Equals(input.AllowDecline) + ) && + ( + this.AllowReassign == input.AllowReassign || + this.AllowReassign.Equals(input.AllowReassign) + ) && + ( + this.Attachments == input.Attachments || + this.Attachments != null && + input.Attachments != null && + this.Attachments.SequenceEqual(input.Attachments) + ) && + ( + this.CcEmailAddresses == input.CcEmailAddresses || + this.CcEmailAddresses != null && + input.CcEmailAddresses != null && + this.CcEmailAddresses.SequenceEqual(input.CcEmailAddresses) + ) && + ( + this.CustomFields == input.CustomFields || + this.CustomFields != null && + input.CustomFields != null && + this.CustomFields.SequenceEqual(input.CustomFields) + ) && + ( + this.FieldOptions == input.FieldOptions || + (this.FieldOptions != null && + this.FieldOptions.Equals(input.FieldOptions)) + ) && + ( + this.FormFieldGroups == input.FormFieldGroups || + this.FormFieldGroups != null && + input.FormFieldGroups != null && + this.FormFieldGroups.SequenceEqual(input.FormFieldGroups) + ) && + ( + this.FormFieldRules == input.FormFieldRules || + this.FormFieldRules != null && + input.FormFieldRules != null && + this.FormFieldRules.SequenceEqual(input.FormFieldRules) + ) && + ( + this.FormFieldsPerDocument == input.FormFieldsPerDocument || + this.FormFieldsPerDocument != null && + input.FormFieldsPerDocument != null && + this.FormFieldsPerDocument.SequenceEqual(input.FormFieldsPerDocument) + ) && + ( + this.HideTextTags == input.HideTextTags || + this.HideTextTags.Equals(input.HideTextTags) + ) && + ( + this.Message == input.Message || + (this.Message != null && + this.Message.Equals(input.Message)) + ) && + ( + this.Metadata == input.Metadata || + this.Metadata != null && + input.Metadata != null && + this.Metadata.SequenceEqual(input.Metadata) + ) && + ( + this.SigningOptions == input.SigningOptions || + (this.SigningOptions != null && + this.SigningOptions.Equals(input.SigningOptions)) + ) && + ( + this.Subject == input.Subject || + (this.Subject != null && + this.Subject.Equals(input.Subject)) + ) && + ( + this.TestMode == input.TestMode || + this.TestMode.Equals(input.TestMode) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ) && + ( + this.UseTextTags == input.UseTextTags || + this.UseTextTags.Equals(input.UseTextTags) + ) && + ( + this.PopulateAutoFillFields == input.PopulateAutoFillFields || + this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) + ) && + ( + this.ExpiresAt == input.ExpiresAt || + (this.ExpiresAt != null && + this.ExpiresAt.Equals(input.ExpiresAt)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.ClientId != null) + { + hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); + } + if (this.Files != null) + { + hashCode = (hashCode * 59) + this.Files.GetHashCode(); + } + if (this.FileUrls != null) + { + hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); + } + if (this.Signers != null) + { + hashCode = (hashCode * 59) + this.Signers.GetHashCode(); + } + if (this.GroupedSigners != null) + { + hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); + } + hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); + if (this.Attachments != null) + { + hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); + } + if (this.CcEmailAddresses != null) + { + hashCode = (hashCode * 59) + this.CcEmailAddresses.GetHashCode(); + } + if (this.CustomFields != null) + { + hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); + } + if (this.FieldOptions != null) + { + hashCode = (hashCode * 59) + this.FieldOptions.GetHashCode(); + } + if (this.FormFieldGroups != null) + { + hashCode = (hashCode * 59) + this.FormFieldGroups.GetHashCode(); + } + if (this.FormFieldRules != null) + { + hashCode = (hashCode * 59) + this.FormFieldRules.GetHashCode(); + } + if (this.FormFieldsPerDocument != null) + { + hashCode = (hashCode * 59) + this.FormFieldsPerDocument.GetHashCode(); + } + hashCode = (hashCode * 59) + this.HideTextTags.GetHashCode(); + if (this.Message != null) + { + hashCode = (hashCode * 59) + this.Message.GetHashCode(); + } + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + if (this.SigningOptions != null) + { + hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); + } + if (this.Subject != null) + { + hashCode = (hashCode * 59) + this.Subject.GetHashCode(); + } + hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); + if (this.ExpiresAt != null) + { + hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + // Message (string) maxLength + if (this.Message != null && this.Message.Length > 5000) + { + yield return new ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); + } + + // Subject (string) maxLength + if (this.Subject != null && this.Subject.Length > 255) + { + yield return new ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); + } + + // Title (string) maxLength + if (this.Title != null && this.Title.Length > 255) + { + yield return new ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); + } + + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "client_id", + Property = "ClientId", + Type = "string", + Value = ClientId, + }); + types.Add(new OpenApiType() + { + Name = "files", + Property = "Files", + Type = "List", + Value = Files, + }); + types.Add(new OpenApiType() + { + Name = "file_urls", + Property = "FileUrls", + Type = "List", + Value = FileUrls, + }); + types.Add(new OpenApiType() + { + Name = "signers", + Property = "Signers", + Type = "List", + Value = Signers, + }); + types.Add(new OpenApiType() + { + Name = "grouped_signers", + Property = "GroupedSigners", + Type = "List", + Value = GroupedSigners, + }); + types.Add(new OpenApiType() + { + Name = "allow_decline", + Property = "AllowDecline", + Type = "bool", + Value = AllowDecline, + }); + types.Add(new OpenApiType() + { + Name = "allow_reassign", + Property = "AllowReassign", + Type = "bool", + Value = AllowReassign, + }); + types.Add(new OpenApiType() + { + Name = "attachments", + Property = "Attachments", + Type = "List", + Value = Attachments, + }); + types.Add(new OpenApiType() + { + Name = "cc_email_addresses", + Property = "CcEmailAddresses", + Type = "List", + Value = CcEmailAddresses, + }); + types.Add(new OpenApiType() + { + Name = "custom_fields", + Property = "CustomFields", + Type = "List", + Value = CustomFields, + }); + types.Add(new OpenApiType() + { + Name = "field_options", + Property = "FieldOptions", + Type = "SubFieldOptions", + Value = FieldOptions, + }); + types.Add(new OpenApiType() + { + Name = "form_field_groups", + Property = "FormFieldGroups", + Type = "List", + Value = FormFieldGroups, + }); + types.Add(new OpenApiType() + { + Name = "form_field_rules", + Property = "FormFieldRules", + Type = "List", + Value = FormFieldRules, + }); + types.Add(new OpenApiType() + { + Name = "form_fields_per_document", + Property = "FormFieldsPerDocument", + Type = "List", + Value = FormFieldsPerDocument, + }); + types.Add(new OpenApiType() + { + Name = "hide_text_tags", + Property = "HideTextTags", + Type = "bool", + Value = HideTextTags, + }); + types.Add(new OpenApiType() + { + Name = "message", + Property = "Message", + Type = "string", + Value = Message, + }); + types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Dictionary", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "signing_options", + Property = "SigningOptions", + Type = "SubSigningOptions", + Value = SigningOptions, + }); + types.Add(new OpenApiType() + { + Name = "subject", + Property = "Subject", + Type = "string", + Value = Subject, + }); + types.Add(new OpenApiType() + { + Name = "test_mode", + Property = "TestMode", + Type = "bool", + Value = TestMode, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + types.Add(new OpenApiType() + { + Name = "use_text_tags", + Property = "UseTextTags", + Type = "bool", + Value = UseTextTags, + }); + types.Add(new OpenApiType() + { + Name = "populate_auto_fill_fields", + Property = "PopulateAutoFillFields", + Type = "bool", + Value = PopulateAutoFillFields, + }); + types.Add(new OpenApiType() + { + Name = "expires_at", + Property = "ExpiresAt", + Type = "int?", + Value = ExpiresAt, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs new file mode 100644 index 000000000..fcf32fa66 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs @@ -0,0 +1,557 @@ +/* + * 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; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// SignatureRequestEditEmbeddedWithTemplateRequest + /// + [DataContract(Name = "SignatureRequestEditEmbeddedWithTemplateRequest")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SignatureRequestEditEmbeddedWithTemplateRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SignatureRequestEditEmbeddedWithTemplateRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. (required). + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Add CC email recipients. Required when a CC role exists for the Template.. + /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). + /// An array defining values and options for custom fields. Required when a custom field exists in the Template.. + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// The custom message in the email that will be sent to the signers.. + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// Add Signers to your Templated-based Signature Request. (required). + /// signingOptions. + /// The subject in the email that will be sent to the signers.. + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). + /// The title you want to assign to the SignatureRequest.. + /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). + public SignatureRequestEditEmbeddedWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool populateAutoFillFields = false) + { + + // to ensure "templateIds" is required (not null) + if (templateIds == null) + { + throw new ArgumentNullException("templateIds is a required property for SignatureRequestEditEmbeddedWithTemplateRequest and cannot be null"); + } + this.TemplateIds = templateIds; + // to ensure "clientId" is required (not null) + if (clientId == null) + { + throw new ArgumentNullException("clientId is a required property for SignatureRequestEditEmbeddedWithTemplateRequest and cannot be null"); + } + this.ClientId = clientId; + // to ensure "signers" is required (not null) + if (signers == null) + { + throw new ArgumentNullException("signers is a required property for SignatureRequestEditEmbeddedWithTemplateRequest and cannot be null"); + } + this.Signers = signers; + this.AllowDecline = allowDecline; + this.Ccs = ccs; + this.CustomFields = customFields; + this.Files = files; + this.FileUrls = fileUrls; + this.Message = message; + this.Metadata = metadata; + this.SigningOptions = signingOptions; + this.Subject = subject; + this.TestMode = testMode; + this.Title = title; + this.PopulateAutoFillFields = populateAutoFillFields; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SignatureRequestEditEmbeddedWithTemplateRequest Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditEmbeddedWithTemplateRequest"); + } + + return obj; + } + + /// + /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + /// + /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + [DataMember(Name = "template_ids", IsRequired = true, EmitDefaultValue = true)] + public List TemplateIds { get; set; } + + /// + /// Client id of the app you're using to create this embedded signature request. Used for security purposes. + /// + /// Client id of the app you're using to create this embedded signature request. Used for security purposes. + [DataMember(Name = "client_id", IsRequired = true, EmitDefaultValue = true)] + public string ClientId { get; set; } + + /// + /// Add Signers to your Templated-based Signature Request. + /// + /// Add Signers to your Templated-based Signature Request. + [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] + public List Signers { get; set; } + + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + [DataMember(Name = "allow_decline", EmitDefaultValue = true)] + public bool AllowDecline { get; set; } + + /// + /// Add CC email recipients. Required when a CC role exists for the Template. + /// + /// Add CC email recipients. Required when a CC role exists for the Template. + [DataMember(Name = "ccs", EmitDefaultValue = true)] + public List Ccs { get; set; } + + /// + /// An array defining values and options for custom fields. Required when a custom field exists in the Template. + /// + /// An array defining values and options for custom fields. Required when a custom field exists in the Template. + [DataMember(Name = "custom_fields", EmitDefaultValue = true)] + public List CustomFields { get; set; } + + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "files", EmitDefaultValue = true)] + public List Files { get; set; } + + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "file_urls", EmitDefaultValue = true)] + public List FileUrls { get; set; } + + /// + /// The custom message in the email that will be sent to the signers. + /// + /// The custom message in the email that will be sent to the signers. + [DataMember(Name = "message", EmitDefaultValue = true)] + public string Message { get; set; } + + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + [DataMember(Name = "metadata", EmitDefaultValue = true)] + public Dictionary Metadata { get; set; } + + /// + /// Gets or Sets SigningOptions + /// + [DataMember(Name = "signing_options", EmitDefaultValue = true)] + public SubSigningOptions SigningOptions { get; set; } + + /// + /// The subject in the email that will be sent to the signers. + /// + /// The subject in the email that will be sent to the signers. + [DataMember(Name = "subject", EmitDefaultValue = true)] + public string Subject { get; set; } + + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + [DataMember(Name = "test_mode", EmitDefaultValue = true)] + public bool TestMode { get; set; } + + /// + /// The title you want to assign to the SignatureRequest. + /// + /// The title you want to assign to the SignatureRequest. + [DataMember(Name = "title", EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + /// + /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] + public bool PopulateAutoFillFields { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SignatureRequestEditEmbeddedWithTemplateRequest {\n"); + sb.Append(" TemplateIds: ").Append(TemplateIds).Append("\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" Signers: ").Append(Signers).Append("\n"); + sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" Ccs: ").Append(Ccs).Append("\n"); + sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); + sb.Append(" Files: ").Append(Files).Append("\n"); + sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); + sb.Append(" Subject: ").Append(Subject).Append("\n"); + sb.Append(" TestMode: ").Append(TestMode).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SignatureRequestEditEmbeddedWithTemplateRequest); + } + + /// + /// Returns true if SignatureRequestEditEmbeddedWithTemplateRequest instances are equal + /// + /// Instance of SignatureRequestEditEmbeddedWithTemplateRequest to be compared + /// Boolean + public bool Equals(SignatureRequestEditEmbeddedWithTemplateRequest input) + { + if (input == null) + { + return false; + } + return + ( + this.TemplateIds == input.TemplateIds || + this.TemplateIds != null && + input.TemplateIds != null && + this.TemplateIds.SequenceEqual(input.TemplateIds) + ) && + ( + this.ClientId == input.ClientId || + (this.ClientId != null && + this.ClientId.Equals(input.ClientId)) + ) && + ( + this.Signers == input.Signers || + this.Signers != null && + input.Signers != null && + this.Signers.SequenceEqual(input.Signers) + ) && + ( + this.AllowDecline == input.AllowDecline || + this.AllowDecline.Equals(input.AllowDecline) + ) && + ( + this.Ccs == input.Ccs || + this.Ccs != null && + input.Ccs != null && + this.Ccs.SequenceEqual(input.Ccs) + ) && + ( + this.CustomFields == input.CustomFields || + this.CustomFields != null && + input.CustomFields != null && + this.CustomFields.SequenceEqual(input.CustomFields) + ) && + ( + this.Files == input.Files || + this.Files != null && + input.Files != null && + this.Files.SequenceEqual(input.Files) + ) && + ( + this.FileUrls == input.FileUrls || + this.FileUrls != null && + input.FileUrls != null && + this.FileUrls.SequenceEqual(input.FileUrls) + ) && + ( + this.Message == input.Message || + (this.Message != null && + this.Message.Equals(input.Message)) + ) && + ( + this.Metadata == input.Metadata || + this.Metadata != null && + input.Metadata != null && + this.Metadata.SequenceEqual(input.Metadata) + ) && + ( + this.SigningOptions == input.SigningOptions || + (this.SigningOptions != null && + this.SigningOptions.Equals(input.SigningOptions)) + ) && + ( + this.Subject == input.Subject || + (this.Subject != null && + this.Subject.Equals(input.Subject)) + ) && + ( + this.TestMode == input.TestMode || + this.TestMode.Equals(input.TestMode) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ) && + ( + this.PopulateAutoFillFields == input.PopulateAutoFillFields || + this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.TemplateIds != null) + { + hashCode = (hashCode * 59) + this.TemplateIds.GetHashCode(); + } + if (this.ClientId != null) + { + hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); + } + if (this.Signers != null) + { + hashCode = (hashCode * 59) + this.Signers.GetHashCode(); + } + hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + if (this.Ccs != null) + { + hashCode = (hashCode * 59) + this.Ccs.GetHashCode(); + } + if (this.CustomFields != null) + { + hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); + } + if (this.Files != null) + { + hashCode = (hashCode * 59) + this.Files.GetHashCode(); + } + if (this.FileUrls != null) + { + hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); + } + if (this.Message != null) + { + hashCode = (hashCode * 59) + this.Message.GetHashCode(); + } + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + if (this.SigningOptions != null) + { + hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); + } + if (this.Subject != null) + { + hashCode = (hashCode * 59) + this.Subject.GetHashCode(); + } + hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + // Message (string) maxLength + if (this.Message != null && this.Message.Length > 5000) + { + yield return new ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); + } + + // Subject (string) maxLength + if (this.Subject != null && this.Subject.Length > 255) + { + yield return new ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); + } + + // Title (string) maxLength + if (this.Title != null && this.Title.Length > 255) + { + yield return new ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); + } + + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "template_ids", + Property = "TemplateIds", + Type = "List", + Value = TemplateIds, + }); + types.Add(new OpenApiType() + { + Name = "client_id", + Property = "ClientId", + Type = "string", + Value = ClientId, + }); + types.Add(new OpenApiType() + { + Name = "signers", + Property = "Signers", + Type = "List", + Value = Signers, + }); + types.Add(new OpenApiType() + { + Name = "allow_decline", + Property = "AllowDecline", + Type = "bool", + Value = AllowDecline, + }); + types.Add(new OpenApiType() + { + Name = "ccs", + Property = "Ccs", + Type = "List", + Value = Ccs, + }); + types.Add(new OpenApiType() + { + Name = "custom_fields", + Property = "CustomFields", + Type = "List", + Value = CustomFields, + }); + types.Add(new OpenApiType() + { + Name = "files", + Property = "Files", + Type = "List", + Value = Files, + }); + types.Add(new OpenApiType() + { + Name = "file_urls", + Property = "FileUrls", + Type = "List", + Value = FileUrls, + }); + types.Add(new OpenApiType() + { + Name = "message", + Property = "Message", + Type = "string", + Value = Message, + }); + types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Dictionary", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "signing_options", + Property = "SigningOptions", + Type = "SubSigningOptions", + Value = SigningOptions, + }); + types.Add(new OpenApiType() + { + Name = "subject", + Property = "Subject", + Type = "string", + Value = Subject, + }); + types.Add(new OpenApiType() + { + Name = "test_mode", + Property = "TestMode", + Type = "bool", + Value = TestMode, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + types.Add(new OpenApiType() + { + Name = "populate_auto_fill_fields", + Property = "PopulateAutoFillFields", + Type = "bool", + Value = PopulateAutoFillFields, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs new file mode 100644 index 000000000..f239fcf60 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs @@ -0,0 +1,793 @@ +/* + * 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; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// SignatureRequestEditRequest + /// + [DataContract(Name = "SignatureRequestEditRequest")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SignatureRequestEditRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SignatureRequestEditRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). + /// A list describing the attachments. + /// The email addresses that should be CCed.. + /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.. + /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. + /// fieldOptions. + /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.. + /// Conditional Logic rules for fields defined in `form_fields_per_document`.. + /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. + /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). + /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). + /// The custom message in the email that will be sent to the signers.. + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// signingOptions. + /// The URL you want signers redirected to after they successfully sign.. + /// The subject in the email that will be sent to the signers.. + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). + /// The title you want to assign to the SignatureRequest.. + /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). + /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. + public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + { + + this.Files = files; + this.FileUrls = fileUrls; + this.Signers = signers; + this.GroupedSigners = groupedSigners; + this.AllowDecline = allowDecline; + this.AllowReassign = allowReassign; + this.Attachments = attachments; + this.CcEmailAddresses = ccEmailAddresses; + this.ClientId = clientId; + this.CustomFields = customFields; + this.FieldOptions = fieldOptions; + this.FormFieldGroups = formFieldGroups; + this.FormFieldRules = formFieldRules; + this.FormFieldsPerDocument = formFieldsPerDocument; + this.HideTextTags = hideTextTags; + this.IsEid = isEid; + this.Message = message; + this.Metadata = metadata; + this.SigningOptions = signingOptions; + this.SigningRedirectUrl = signingRedirectUrl; + this.Subject = subject; + this.TestMode = testMode; + this.Title = title; + this.UseTextTags = useTextTags; + this.ExpiresAt = expiresAt; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SignatureRequestEditRequest Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditRequest"); + } + + return obj; + } + + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "files", EmitDefaultValue = true)] + public List Files { get; set; } + + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "file_urls", EmitDefaultValue = true)] + public List FileUrls { get; set; } + + /// + /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// + /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + [DataMember(Name = "signers", EmitDefaultValue = true)] + public List Signers { get; set; } + + /// + /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// + /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] + public List GroupedSigners { get; set; } + + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + [DataMember(Name = "allow_decline", EmitDefaultValue = true)] + public bool AllowDecline { get; set; } + + /// + /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + /// + /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] + public bool AllowReassign { get; set; } + + /// + /// A list describing the attachments + /// + /// A list describing the attachments + [DataMember(Name = "attachments", EmitDefaultValue = true)] + public List Attachments { get; set; } + + /// + /// The email addresses that should be CCed. + /// + /// The email addresses that should be CCed. + [DataMember(Name = "cc_email_addresses", EmitDefaultValue = true)] + public List CcEmailAddresses { get; set; } + + /// + /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + /// + /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + [DataMember(Name = "client_id", EmitDefaultValue = true)] + public string ClientId { get; set; } + + /// + /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + /// + /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + [DataMember(Name = "custom_fields", EmitDefaultValue = true)] + public List CustomFields { get; set; } + + /// + /// Gets or Sets FieldOptions + /// + [DataMember(Name = "field_options", EmitDefaultValue = true)] + public SubFieldOptions FieldOptions { get; set; } + + /// + /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + /// + /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + [DataMember(Name = "form_field_groups", EmitDefaultValue = true)] + public List FormFieldGroups { get; set; } + + /// + /// Conditional Logic rules for fields defined in `form_fields_per_document`. + /// + /// Conditional Logic rules for fields defined in `form_fields_per_document`. + [DataMember(Name = "form_field_rules", EmitDefaultValue = true)] + public List FormFieldRules { get; set; } + + /// + /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + /// + /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + [DataMember(Name = "form_fields_per_document", EmitDefaultValue = true)] + public List FormFieldsPerDocument { get; set; } + + /// + /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + /// + /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + [DataMember(Name = "hide_text_tags", EmitDefaultValue = true)] + public bool HideTextTags { get; set; } + + /// + /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + /// + /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + [DataMember(Name = "is_eid", EmitDefaultValue = true)] + public bool IsEid { get; set; } + + /// + /// The custom message in the email that will be sent to the signers. + /// + /// The custom message in the email that will be sent to the signers. + [DataMember(Name = "message", EmitDefaultValue = true)] + public string Message { get; set; } + + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + [DataMember(Name = "metadata", EmitDefaultValue = true)] + public Dictionary Metadata { get; set; } + + /// + /// Gets or Sets SigningOptions + /// + [DataMember(Name = "signing_options", EmitDefaultValue = true)] + public SubSigningOptions SigningOptions { get; set; } + + /// + /// The URL you want signers redirected to after they successfully sign. + /// + /// The URL you want signers redirected to after they successfully sign. + [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] + public string SigningRedirectUrl { get; set; } + + /// + /// The subject in the email that will be sent to the signers. + /// + /// The subject in the email that will be sent to the signers. + [DataMember(Name = "subject", EmitDefaultValue = true)] + public string Subject { get; set; } + + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + [DataMember(Name = "test_mode", EmitDefaultValue = true)] + public bool TestMode { get; set; } + + /// + /// The title you want to assign to the SignatureRequest. + /// + /// The title you want to assign to the SignatureRequest. + [DataMember(Name = "title", EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + /// + /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] + public bool UseTextTags { get; set; } + + /// + /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + /// + /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + [DataMember(Name = "expires_at", EmitDefaultValue = true)] + public int? ExpiresAt { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SignatureRequestEditRequest {\n"); + sb.Append(" Files: ").Append(Files).Append("\n"); + sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); + sb.Append(" Signers: ").Append(Signers).Append("\n"); + sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); + sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); + sb.Append(" Attachments: ").Append(Attachments).Append("\n"); + sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); + sb.Append(" FieldOptions: ").Append(FieldOptions).Append("\n"); + sb.Append(" FormFieldGroups: ").Append(FormFieldGroups).Append("\n"); + sb.Append(" FormFieldRules: ").Append(FormFieldRules).Append("\n"); + sb.Append(" FormFieldsPerDocument: ").Append(FormFieldsPerDocument).Append("\n"); + sb.Append(" HideTextTags: ").Append(HideTextTags).Append("\n"); + sb.Append(" IsEid: ").Append(IsEid).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); + sb.Append(" SigningRedirectUrl: ").Append(SigningRedirectUrl).Append("\n"); + sb.Append(" Subject: ").Append(Subject).Append("\n"); + sb.Append(" TestMode: ").Append(TestMode).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SignatureRequestEditRequest); + } + + /// + /// Returns true if SignatureRequestEditRequest instances are equal + /// + /// Instance of SignatureRequestEditRequest to be compared + /// Boolean + public bool Equals(SignatureRequestEditRequest input) + { + if (input == null) + { + return false; + } + return + ( + this.Files == input.Files || + this.Files != null && + input.Files != null && + this.Files.SequenceEqual(input.Files) + ) && + ( + this.FileUrls == input.FileUrls || + this.FileUrls != null && + input.FileUrls != null && + this.FileUrls.SequenceEqual(input.FileUrls) + ) && + ( + this.Signers == input.Signers || + this.Signers != null && + input.Signers != null && + this.Signers.SequenceEqual(input.Signers) + ) && + ( + this.GroupedSigners == input.GroupedSigners || + this.GroupedSigners != null && + input.GroupedSigners != null && + this.GroupedSigners.SequenceEqual(input.GroupedSigners) + ) && + ( + this.AllowDecline == input.AllowDecline || + this.AllowDecline.Equals(input.AllowDecline) + ) && + ( + this.AllowReassign == input.AllowReassign || + this.AllowReassign.Equals(input.AllowReassign) + ) && + ( + this.Attachments == input.Attachments || + this.Attachments != null && + input.Attachments != null && + this.Attachments.SequenceEqual(input.Attachments) + ) && + ( + this.CcEmailAddresses == input.CcEmailAddresses || + this.CcEmailAddresses != null && + input.CcEmailAddresses != null && + this.CcEmailAddresses.SequenceEqual(input.CcEmailAddresses) + ) && + ( + this.ClientId == input.ClientId || + (this.ClientId != null && + this.ClientId.Equals(input.ClientId)) + ) && + ( + this.CustomFields == input.CustomFields || + this.CustomFields != null && + input.CustomFields != null && + this.CustomFields.SequenceEqual(input.CustomFields) + ) && + ( + this.FieldOptions == input.FieldOptions || + (this.FieldOptions != null && + this.FieldOptions.Equals(input.FieldOptions)) + ) && + ( + this.FormFieldGroups == input.FormFieldGroups || + this.FormFieldGroups != null && + input.FormFieldGroups != null && + this.FormFieldGroups.SequenceEqual(input.FormFieldGroups) + ) && + ( + this.FormFieldRules == input.FormFieldRules || + this.FormFieldRules != null && + input.FormFieldRules != null && + this.FormFieldRules.SequenceEqual(input.FormFieldRules) + ) && + ( + this.FormFieldsPerDocument == input.FormFieldsPerDocument || + this.FormFieldsPerDocument != null && + input.FormFieldsPerDocument != null && + this.FormFieldsPerDocument.SequenceEqual(input.FormFieldsPerDocument) + ) && + ( + this.HideTextTags == input.HideTextTags || + this.HideTextTags.Equals(input.HideTextTags) + ) && + ( + this.IsEid == input.IsEid || + this.IsEid.Equals(input.IsEid) + ) && + ( + this.Message == input.Message || + (this.Message != null && + this.Message.Equals(input.Message)) + ) && + ( + this.Metadata == input.Metadata || + this.Metadata != null && + input.Metadata != null && + this.Metadata.SequenceEqual(input.Metadata) + ) && + ( + this.SigningOptions == input.SigningOptions || + (this.SigningOptions != null && + this.SigningOptions.Equals(input.SigningOptions)) + ) && + ( + this.SigningRedirectUrl == input.SigningRedirectUrl || + (this.SigningRedirectUrl != null && + this.SigningRedirectUrl.Equals(input.SigningRedirectUrl)) + ) && + ( + this.Subject == input.Subject || + (this.Subject != null && + this.Subject.Equals(input.Subject)) + ) && + ( + this.TestMode == input.TestMode || + this.TestMode.Equals(input.TestMode) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ) && + ( + this.UseTextTags == input.UseTextTags || + this.UseTextTags.Equals(input.UseTextTags) + ) && + ( + this.ExpiresAt == input.ExpiresAt || + (this.ExpiresAt != null && + this.ExpiresAt.Equals(input.ExpiresAt)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Files != null) + { + hashCode = (hashCode * 59) + this.Files.GetHashCode(); + } + if (this.FileUrls != null) + { + hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); + } + if (this.Signers != null) + { + hashCode = (hashCode * 59) + this.Signers.GetHashCode(); + } + if (this.GroupedSigners != null) + { + hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); + } + hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); + if (this.Attachments != null) + { + hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); + } + if (this.CcEmailAddresses != null) + { + hashCode = (hashCode * 59) + this.CcEmailAddresses.GetHashCode(); + } + if (this.ClientId != null) + { + hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); + } + if (this.CustomFields != null) + { + hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); + } + if (this.FieldOptions != null) + { + hashCode = (hashCode * 59) + this.FieldOptions.GetHashCode(); + } + if (this.FormFieldGroups != null) + { + hashCode = (hashCode * 59) + this.FormFieldGroups.GetHashCode(); + } + if (this.FormFieldRules != null) + { + hashCode = (hashCode * 59) + this.FormFieldRules.GetHashCode(); + } + if (this.FormFieldsPerDocument != null) + { + hashCode = (hashCode * 59) + this.FormFieldsPerDocument.GetHashCode(); + } + hashCode = (hashCode * 59) + this.HideTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IsEid.GetHashCode(); + if (this.Message != null) + { + hashCode = (hashCode * 59) + this.Message.GetHashCode(); + } + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + if (this.SigningOptions != null) + { + hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); + } + if (this.SigningRedirectUrl != null) + { + hashCode = (hashCode * 59) + this.SigningRedirectUrl.GetHashCode(); + } + if (this.Subject != null) + { + hashCode = (hashCode * 59) + this.Subject.GetHashCode(); + } + hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + if (this.ExpiresAt != null) + { + hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + // Message (string) maxLength + if (this.Message != null && this.Message.Length > 5000) + { + yield return new ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); + } + + // Subject (string) maxLength + if (this.Subject != null && this.Subject.Length > 255) + { + yield return new ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); + } + + // Title (string) maxLength + if (this.Title != null && this.Title.Length > 255) + { + yield return new ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); + } + + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "files", + Property = "Files", + Type = "List", + Value = Files, + }); + types.Add(new OpenApiType() + { + Name = "file_urls", + Property = "FileUrls", + Type = "List", + Value = FileUrls, + }); + types.Add(new OpenApiType() + { + Name = "signers", + Property = "Signers", + Type = "List", + Value = Signers, + }); + types.Add(new OpenApiType() + { + Name = "grouped_signers", + Property = "GroupedSigners", + Type = "List", + Value = GroupedSigners, + }); + types.Add(new OpenApiType() + { + Name = "allow_decline", + Property = "AllowDecline", + Type = "bool", + Value = AllowDecline, + }); + types.Add(new OpenApiType() + { + Name = "allow_reassign", + Property = "AllowReassign", + Type = "bool", + Value = AllowReassign, + }); + types.Add(new OpenApiType() + { + Name = "attachments", + Property = "Attachments", + Type = "List", + Value = Attachments, + }); + types.Add(new OpenApiType() + { + Name = "cc_email_addresses", + Property = "CcEmailAddresses", + Type = "List", + Value = CcEmailAddresses, + }); + types.Add(new OpenApiType() + { + Name = "client_id", + Property = "ClientId", + Type = "string", + Value = ClientId, + }); + types.Add(new OpenApiType() + { + Name = "custom_fields", + Property = "CustomFields", + Type = "List", + Value = CustomFields, + }); + types.Add(new OpenApiType() + { + Name = "field_options", + Property = "FieldOptions", + Type = "SubFieldOptions", + Value = FieldOptions, + }); + types.Add(new OpenApiType() + { + Name = "form_field_groups", + Property = "FormFieldGroups", + Type = "List", + Value = FormFieldGroups, + }); + types.Add(new OpenApiType() + { + Name = "form_field_rules", + Property = "FormFieldRules", + Type = "List", + Value = FormFieldRules, + }); + types.Add(new OpenApiType() + { + Name = "form_fields_per_document", + Property = "FormFieldsPerDocument", + Type = "List", + Value = FormFieldsPerDocument, + }); + types.Add(new OpenApiType() + { + Name = "hide_text_tags", + Property = "HideTextTags", + Type = "bool", + Value = HideTextTags, + }); + types.Add(new OpenApiType() + { + Name = "is_eid", + Property = "IsEid", + Type = "bool", + Value = IsEid, + }); + types.Add(new OpenApiType() + { + Name = "message", + Property = "Message", + Type = "string", + Value = Message, + }); + types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Dictionary", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "signing_options", + Property = "SigningOptions", + Type = "SubSigningOptions", + Value = SigningOptions, + }); + types.Add(new OpenApiType() + { + Name = "signing_redirect_url", + Property = "SigningRedirectUrl", + Type = "string", + Value = SigningRedirectUrl, + }); + types.Add(new OpenApiType() + { + Name = "subject", + Property = "Subject", + Type = "string", + Value = Subject, + }); + types.Add(new OpenApiType() + { + Name = "test_mode", + Property = "TestMode", + Type = "bool", + Value = TestMode, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + types.Add(new OpenApiType() + { + Name = "use_text_tags", + Property = "UseTextTags", + Type = "bool", + Value = UseTextTags, + }); + types.Add(new OpenApiType() + { + Name = "expires_at", + Property = "ExpiresAt", + Type = "int?", + Value = ExpiresAt, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs new file mode 100644 index 000000000..84990b8ff --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs @@ -0,0 +1,578 @@ +/* + * 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; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// SignatureRequestEditWithTemplateRequest + /// + [DataContract(Name = "SignatureRequestEditWithTemplateRequest")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SignatureRequestEditWithTemplateRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SignatureRequestEditWithTemplateRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. (required). + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Add CC email recipients. Required when a CC role exists for the Template.. + /// Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.. + /// An array defining values and options for custom fields. Required when a custom field exists in the Template.. + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). + /// The custom message in the email that will be sent to the signers.. + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// Add Signers to your Templated-based Signature Request. (required). + /// signingOptions. + /// The URL you want signers redirected to after they successfully sign.. + /// The subject in the email that will be sent to the signers.. + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). + /// The title you want to assign to the SignatureRequest.. + public SignatureRequestEditWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string)) + { + + // to ensure "templateIds" is required (not null) + if (templateIds == null) + { + throw new ArgumentNullException("templateIds is a required property for SignatureRequestEditWithTemplateRequest and cannot be null"); + } + this.TemplateIds = templateIds; + // to ensure "signers" is required (not null) + if (signers == null) + { + throw new ArgumentNullException("signers is a required property for SignatureRequestEditWithTemplateRequest and cannot be null"); + } + this.Signers = signers; + this.AllowDecline = allowDecline; + this.Ccs = ccs; + this.ClientId = clientId; + this.CustomFields = customFields; + this.Files = files; + this.FileUrls = fileUrls; + this.IsEid = isEid; + this.Message = message; + this.Metadata = metadata; + this.SigningOptions = signingOptions; + this.SigningRedirectUrl = signingRedirectUrl; + this.Subject = subject; + this.TestMode = testMode; + this.Title = title; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SignatureRequestEditWithTemplateRequest Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditWithTemplateRequest"); + } + + return obj; + } + + /// + /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + /// + /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + [DataMember(Name = "template_ids", IsRequired = true, EmitDefaultValue = true)] + public List TemplateIds { get; set; } + + /// + /// Add Signers to your Templated-based Signature Request. + /// + /// Add Signers to your Templated-based Signature Request. + [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] + public List Signers { get; set; } + + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + /// + /// Allows signers to decline to sign a document if `true`. Defaults to `false`. + [DataMember(Name = "allow_decline", EmitDefaultValue = true)] + public bool AllowDecline { get; set; } + + /// + /// Add CC email recipients. Required when a CC role exists for the Template. + /// + /// Add CC email recipients. Required when a CC role exists for the Template. + [DataMember(Name = "ccs", EmitDefaultValue = true)] + public List Ccs { get; set; } + + /// + /// Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + /// + /// Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + [DataMember(Name = "client_id", EmitDefaultValue = true)] + public string ClientId { get; set; } + + /// + /// An array defining values and options for custom fields. Required when a custom field exists in the Template. + /// + /// An array defining values and options for custom fields. Required when a custom field exists in the Template. + [DataMember(Name = "custom_fields", EmitDefaultValue = true)] + public List CustomFields { get; set; } + + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "files", EmitDefaultValue = true)] + public List Files { get; set; } + + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + /// + /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + [DataMember(Name = "file_urls", EmitDefaultValue = true)] + public List FileUrls { get; set; } + + /// + /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + /// + /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + [DataMember(Name = "is_eid", EmitDefaultValue = true)] + public bool IsEid { get; set; } + + /// + /// The custom message in the email that will be sent to the signers. + /// + /// The custom message in the email that will be sent to the signers. + [DataMember(Name = "message", EmitDefaultValue = true)] + public string Message { get; set; } + + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// + /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + [DataMember(Name = "metadata", EmitDefaultValue = true)] + public Dictionary Metadata { get; set; } + + /// + /// Gets or Sets SigningOptions + /// + [DataMember(Name = "signing_options", EmitDefaultValue = true)] + public SubSigningOptions SigningOptions { get; set; } + + /// + /// The URL you want signers redirected to after they successfully sign. + /// + /// The URL you want signers redirected to after they successfully sign. + [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] + public string SigningRedirectUrl { get; set; } + + /// + /// The subject in the email that will be sent to the signers. + /// + /// The subject in the email that will be sent to the signers. + [DataMember(Name = "subject", EmitDefaultValue = true)] + public string Subject { get; set; } + + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + /// + /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + [DataMember(Name = "test_mode", EmitDefaultValue = true)] + public bool TestMode { get; set; } + + /// + /// The title you want to assign to the SignatureRequest. + /// + /// The title you want to assign to the SignatureRequest. + [DataMember(Name = "title", EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SignatureRequestEditWithTemplateRequest {\n"); + sb.Append(" TemplateIds: ").Append(TemplateIds).Append("\n"); + sb.Append(" Signers: ").Append(Signers).Append("\n"); + sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" Ccs: ").Append(Ccs).Append("\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); + sb.Append(" Files: ").Append(Files).Append("\n"); + sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); + sb.Append(" IsEid: ").Append(IsEid).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); + sb.Append(" SigningRedirectUrl: ").Append(SigningRedirectUrl).Append("\n"); + sb.Append(" Subject: ").Append(Subject).Append("\n"); + sb.Append(" TestMode: ").Append(TestMode).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SignatureRequestEditWithTemplateRequest); + } + + /// + /// Returns true if SignatureRequestEditWithTemplateRequest instances are equal + /// + /// Instance of SignatureRequestEditWithTemplateRequest to be compared + /// Boolean + public bool Equals(SignatureRequestEditWithTemplateRequest input) + { + if (input == null) + { + return false; + } + return + ( + this.TemplateIds == input.TemplateIds || + this.TemplateIds != null && + input.TemplateIds != null && + this.TemplateIds.SequenceEqual(input.TemplateIds) + ) && + ( + this.Signers == input.Signers || + this.Signers != null && + input.Signers != null && + this.Signers.SequenceEqual(input.Signers) + ) && + ( + this.AllowDecline == input.AllowDecline || + this.AllowDecline.Equals(input.AllowDecline) + ) && + ( + this.Ccs == input.Ccs || + this.Ccs != null && + input.Ccs != null && + this.Ccs.SequenceEqual(input.Ccs) + ) && + ( + this.ClientId == input.ClientId || + (this.ClientId != null && + this.ClientId.Equals(input.ClientId)) + ) && + ( + this.CustomFields == input.CustomFields || + this.CustomFields != null && + input.CustomFields != null && + this.CustomFields.SequenceEqual(input.CustomFields) + ) && + ( + this.Files == input.Files || + this.Files != null && + input.Files != null && + this.Files.SequenceEqual(input.Files) + ) && + ( + this.FileUrls == input.FileUrls || + this.FileUrls != null && + input.FileUrls != null && + this.FileUrls.SequenceEqual(input.FileUrls) + ) && + ( + this.IsEid == input.IsEid || + this.IsEid.Equals(input.IsEid) + ) && + ( + this.Message == input.Message || + (this.Message != null && + this.Message.Equals(input.Message)) + ) && + ( + this.Metadata == input.Metadata || + this.Metadata != null && + input.Metadata != null && + this.Metadata.SequenceEqual(input.Metadata) + ) && + ( + this.SigningOptions == input.SigningOptions || + (this.SigningOptions != null && + this.SigningOptions.Equals(input.SigningOptions)) + ) && + ( + this.SigningRedirectUrl == input.SigningRedirectUrl || + (this.SigningRedirectUrl != null && + this.SigningRedirectUrl.Equals(input.SigningRedirectUrl)) + ) && + ( + this.Subject == input.Subject || + (this.Subject != null && + this.Subject.Equals(input.Subject)) + ) && + ( + this.TestMode == input.TestMode || + this.TestMode.Equals(input.TestMode) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.TemplateIds != null) + { + hashCode = (hashCode * 59) + this.TemplateIds.GetHashCode(); + } + if (this.Signers != null) + { + hashCode = (hashCode * 59) + this.Signers.GetHashCode(); + } + hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + if (this.Ccs != null) + { + hashCode = (hashCode * 59) + this.Ccs.GetHashCode(); + } + if (this.ClientId != null) + { + hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); + } + if (this.CustomFields != null) + { + hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); + } + if (this.Files != null) + { + hashCode = (hashCode * 59) + this.Files.GetHashCode(); + } + if (this.FileUrls != null) + { + hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); + } + hashCode = (hashCode * 59) + this.IsEid.GetHashCode(); + if (this.Message != null) + { + hashCode = (hashCode * 59) + this.Message.GetHashCode(); + } + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + if (this.SigningOptions != null) + { + hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); + } + if (this.SigningRedirectUrl != null) + { + hashCode = (hashCode * 59) + this.SigningRedirectUrl.GetHashCode(); + } + if (this.Subject != null) + { + hashCode = (hashCode * 59) + this.Subject.GetHashCode(); + } + hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + // Message (string) maxLength + if (this.Message != null && this.Message.Length > 5000) + { + yield return new ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); + } + + // Subject (string) maxLength + if (this.Subject != null && this.Subject.Length > 255) + { + yield return new ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); + } + + // Title (string) maxLength + if (this.Title != null && this.Title.Length > 255) + { + yield return new ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); + } + + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "template_ids", + Property = "TemplateIds", + Type = "List", + Value = TemplateIds, + }); + types.Add(new OpenApiType() + { + Name = "signers", + Property = "Signers", + Type = "List", + Value = Signers, + }); + types.Add(new OpenApiType() + { + Name = "allow_decline", + Property = "AllowDecline", + Type = "bool", + Value = AllowDecline, + }); + types.Add(new OpenApiType() + { + Name = "ccs", + Property = "Ccs", + Type = "List", + Value = Ccs, + }); + types.Add(new OpenApiType() + { + Name = "client_id", + Property = "ClientId", + Type = "string", + Value = ClientId, + }); + types.Add(new OpenApiType() + { + Name = "custom_fields", + Property = "CustomFields", + Type = "List", + Value = CustomFields, + }); + types.Add(new OpenApiType() + { + Name = "files", + Property = "Files", + Type = "List", + Value = Files, + }); + types.Add(new OpenApiType() + { + Name = "file_urls", + Property = "FileUrls", + Type = "List", + Value = FileUrls, + }); + types.Add(new OpenApiType() + { + Name = "is_eid", + Property = "IsEid", + Type = "bool", + Value = IsEid, + }); + types.Add(new OpenApiType() + { + Name = "message", + Property = "Message", + Type = "string", + Value = Message, + }); + types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Dictionary", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "signing_options", + Property = "SigningOptions", + Type = "SubSigningOptions", + Value = SigningOptions, + }); + types.Add(new OpenApiType() + { + Name = "signing_redirect_url", + Property = "SigningRedirectUrl", + Type = "string", + Value = SigningRedirectUrl, + }); + types.Add(new OpenApiType() + { + Name = "subject", + Property = "Subject", + Type = "string", + Value = Subject, + }); + types.Add(new OpenApiType() + { + Name = "test_mode", + Property = "TestMode", + Type = "bool", + Value = TestMode, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + + return types; + } + } + +} diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index d5f7354bc..5a19d8db9 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -197,6 +197,10 @@ Class | Method | HTTP request | Description *SignatureRequestApi* | [**signatureRequestCancel**](docs/SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](docs/SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +*SignatureRequestApi* | [**signatureRequestEdit**](docs/SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +*SignatureRequestApi* | [**signatureRequestEditEmbedded**](docs/SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +*SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +*SignatureRequestApi* | [**signatureRequestEditWithTemplate**](docs/SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template *SignatureRequestApi* | [**signatureRequestFiles**](docs/SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](docs/SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](docs/SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -300,6 +304,10 @@ Class | Method | HTTP request | Description - [SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) diff --git a/sdks/java-v1/docs/SignatureRequestApi.md b/sdks/java-v1/docs/SignatureRequestApi.md index 60e02426f..4a9a22b75 100644 --- a/sdks/java-v1/docs/SignatureRequestApi.md +++ b/sdks/java-v1/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3* [**signatureRequestCancel**](SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request [**signatureRequestCreateEmbedded**](SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request [**signatureRequestCreateEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +[**signatureRequestEdit**](SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +[**signatureRequestEditEmbedded**](SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +[**signatureRequestEditEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +[**signatureRequestEditWithTemplate**](SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template [**signatureRequestFiles**](SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files [**signatureRequestFilesAsDataUri**](SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri [**signatureRequestFilesAsFileUrl**](SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -532,6 +536,442 @@ public class Example { | **4XX** | failed_operation | - | +## signatureRequestEdit + +> SignatureRequestGetResponse signatureRequestEdit(signatureRequestId, signatureRequestEditRequest) + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + +**NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.util.List; +import java.util.Map; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestSigner() + .emailAddress("jack@example.com") + .name("Jack") + .order(0); + + var signer2 = new SubSignatureRequestSigner() + .emailAddress("jill@example.com") + .name("Jill") + .order(1); + + var signingOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(true) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var subFieldOptions = new SubFieldOptions() + .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditRequest() + .title("NDA with Acme Co.") + .subject("The NDA we talked about") + .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + .signers(List.of(signer1, signer2)) + .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) + .addFilesItem(new File("example_signature_request.pdf")) + .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) + .signingOptions(signingOptions) + .fieldOptions(subFieldOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditRequest** | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + +## signatureRequestEditEmbedded + +> SignatureRequestGetResponse signatureRequestEditEmbedded(signatureRequestId, signatureRequestEditEmbeddedRequest) + +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestSigner() + .emailAddress("jack@example.com") + .name("Jack") + .order(0); + + var signer2 = new SubSignatureRequestSigner() + .emailAddress("jill@example.com") + .name("Jill") + .order(1); + + var signingOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(true) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditEmbeddedRequest() + .clientId("ec64a202072370a737edf4a0eb7f4437") + .title("NDA with Acme Co.") + .subject("The NDA we talked about") + .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + .signers(List.of(signer1, signer2)) + .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) + .addFilesItem(new File("example_signature_request.pdf")) + .signingOptions(signingOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( + signatureRequestId, + data + ); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditEmbeddedRequest** | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + +## signatureRequestEditEmbeddedWithTemplate + +> SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest) + +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestTemplateSigner() + .role("Client") + .name("George"); + + var subSigningOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(false) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditEmbeddedWithTemplateRequest() + .clientId("ec64a202072370a737edf4a0eb7f4437") + .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) + .subject("Purchase Order") + .message("Glad we could come to an agreement.") + .signers(List.of(signer1)) + .signingOptions(subSigningOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( + signatureRequestId, + data + ); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditEmbeddedWithTemplateRequest** | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + +## signatureRequestEditWithTemplate + +> SignatureRequestGetResponse signatureRequestEditWithTemplate(signatureRequestId, signatureRequestEditWithTemplateRequest) + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. + +**NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestTemplateSigner() + .role("Client") + .emailAddress("george@example.com") + .name("George"); + + var cc1 = new SubCC() + .role("Accounting") + .emailAddress("accouting@emaple.com"); + + var customField1 = new SubCustomField() + .name("Cost") + .value("$20,000") + .editor("Client") + .required(true); + + var signingOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(false) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditWithTemplateRequest() + .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) + .subject("Purchase Order") + .message("Glad we could come to an agreement.") + .signers(List.of(signer1)) + .ccs(List.of(cc1)) + .customFields(List.of(customField1)) + .signingOptions(signingOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( + signatureRequestId, + data + ); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditWithTemplateRequest** | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + ## signatureRequestFiles > File signatureRequestFiles(signatureRequestId, fileType) diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..dd8b06061 --- /dev/null +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,37 @@ + + +# SignatureRequestEditEmbeddedRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | +| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | +| `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```List```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + + + diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..3cc3dee72 --- /dev/null +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,28 @@ + + +# SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | + + + diff --git a/sdks/java-v1/docs/SignatureRequestEditRequest.md b/sdks/java-v1/docs/SignatureRequestEditRequest.md new file mode 100644 index 000000000..7fa3aca65 --- /dev/null +++ b/sdks/java-v1/docs/SignatureRequestEditRequest.md @@ -0,0 +1,38 @@ + + +# SignatureRequestEditRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | +| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | +| `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```List```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | +| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + + + diff --git a/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..d079524b1 --- /dev/null +++ b/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,29 @@ + + +# SignatureRequestEditWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | + + + diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java index 8474ef706..6996e6c02 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java @@ -12,6 +12,10 @@ import com.dropbox.sign.model.SignatureRequestBulkSendWithTemplateRequest; import com.dropbox.sign.model.SignatureRequestCreateEmbeddedRequest; import com.dropbox.sign.model.SignatureRequestCreateEmbeddedWithTemplateRequest; +import com.dropbox.sign.model.SignatureRequestEditEmbeddedRequest; +import com.dropbox.sign.model.SignatureRequestEditEmbeddedWithTemplateRequest; +import com.dropbox.sign.model.SignatureRequestEditRequest; +import com.dropbox.sign.model.SignatureRequestEditWithTemplateRequest; import com.dropbox.sign.model.SignatureRequestGetResponse; import com.dropbox.sign.model.SignatureRequestListResponse; import com.dropbox.sign.model.SignatureRequestRemindRequest; @@ -493,6 +497,397 @@ public SignatureRequestGetResponse signatureRequestCreateEmbeddedWithTemplate( false); } + /** + * Edit Signature Request. Edits and sends a SignatureRequest with the submitted documents. If + * `form_fields_per_document` is not specified, a signature page will be affixed where + * all signers will be required to add their signature, signifying their agreement to all + * contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEdit( + String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) + throws ApiException { + return signatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest) + .getData(); + } + + /** + * Edit Signature Request. Edits and sends a SignatureRequest with the submitted documents. If + * `form_fields_per_document` is not specified, a signature page will be affixed where + * all signers will be required to add their signature, signifying their agreement to all + * contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditWithHttpInfo( + String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) + throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestId' when calling" + + " signatureRequestEdit"); + } + if (signatureRequestEditRequest == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestEditRequest' when calling" + + " signatureRequestEdit"); + } + + // Path parameters + String localVarPath = + "/signature_request/edit/{signature_request_id}" + .replaceAll( + "\\{signature_request_id}", + apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound + ? "multipart/form-data" + : apiClient.selectHeaderContentType( + "application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = + new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEdit", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + + /** + * Edit Embedded Signature Request. Edits a SignatureRequest with the submitted documents to be + * signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page + * will be affixed where all signers will be required to add their signature, signifying their + * agreement to all contained documents. Note that embedded signature requests can only be + * signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox + * Sign. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEditEmbedded( + String signatureRequestId, + SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) + throws ApiException { + return signatureRequestEditEmbeddedWithHttpInfo( + signatureRequestId, signatureRequestEditEmbeddedRequest) + .getData(); + } + + /** + * Edit Embedded Signature Request. Edits a SignatureRequest with the submitted documents to be + * signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page + * will be affixed where all signers will be required to add their signature, signifying their + * agreement to all contained documents. Note that embedded signature requests can only be + * signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox + * Sign. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditEmbeddedWithHttpInfo( + String signatureRequestId, + SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) + throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestId' when calling" + + " signatureRequestEditEmbedded"); + } + if (signatureRequestEditEmbeddedRequest == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestEditEmbeddedRequest' when" + + " calling signatureRequestEditEmbedded"); + } + + // Path parameters + String localVarPath = + "/signature_request/edit_embedded/{signature_request_id}" + .replaceAll( + "\\{signature_request_id}", + apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditEmbeddedRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound + ? "multipart/form-data" + : apiClient.selectHeaderContentType( + "application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = + new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEditEmbedded", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditEmbeddedRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + + /** + * Edit Embedded Signature Request with Template. Edits a SignatureRequest based on the given + * Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can + * only be signed in embedded iFrames whereas normal signature requests can only be signed on + * Dropbox Sign. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedWithTemplateRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate( + String signatureRequestId, + SignatureRequestEditEmbeddedWithTemplateRequest + signatureRequestEditEmbeddedWithTemplateRequest) + throws ApiException { + return signatureRequestEditEmbeddedWithTemplateWithHttpInfo( + signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest) + .getData(); + } + + /** + * Edit Embedded Signature Request with Template. Edits a SignatureRequest based on the given + * Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can + * only be signed in embedded iFrames whereas normal signature requests can only be signed on + * Dropbox Sign. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedWithTemplateRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse + signatureRequestEditEmbeddedWithTemplateWithHttpInfo( + String signatureRequestId, + SignatureRequestEditEmbeddedWithTemplateRequest + signatureRequestEditEmbeddedWithTemplateRequest) + throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestId' when calling" + + " signatureRequestEditEmbeddedWithTemplate"); + } + if (signatureRequestEditEmbeddedWithTemplateRequest == null) { + throw new ApiException( + 400, + "Missing the required parameter" + + " 'signatureRequestEditEmbeddedWithTemplateRequest' when calling" + + " signatureRequestEditEmbeddedWithTemplate"); + } + + // Path parameters + String localVarPath = + "/signature_request/edit_embedded_with_template/{signature_request_id}" + .replaceAll( + "\\{signature_request_id}", + apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditEmbeddedWithTemplateRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound + ? "multipart/form-data" + : apiClient.selectHeaderContentType( + "application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = + new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEditEmbeddedWithTemplate", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditEmbeddedWithTemplateRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + + /** + * Edit Signature Request With Template. Edits and sends a SignatureRequest based off of the + * Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not + * deduct your signature request quota. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditWithTemplateRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEditWithTemplate( + String signatureRequestId, + SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) + throws ApiException { + return signatureRequestEditWithTemplateWithHttpInfo( + signatureRequestId, signatureRequestEditWithTemplateRequest) + .getData(); + } + + /** + * Edit Signature Request With Template. Edits and sends a SignatureRequest based off of the + * Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not + * deduct your signature request quota. + * + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditWithTemplateRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditWithTemplateWithHttpInfo( + String signatureRequestId, + SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) + throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestId' when calling" + + " signatureRequestEditWithTemplate"); + } + if (signatureRequestEditWithTemplateRequest == null) { + throw new ApiException( + 400, + "Missing the required parameter 'signatureRequestEditWithTemplateRequest' when" + + " calling signatureRequestEditWithTemplate"); + } + + // Path parameters + String localVarPath = + "/signature_request/edit_with_template/{signature_request_id}" + .replaceAll( + "\\{signature_request_id}", + apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditWithTemplateRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound + ? "multipart/form-data" + : apiClient.selectHeaderContentType( + "application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = + new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEditWithTemplate", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditWithTemplateRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + /** * Download Files. Obtain a copy of the current documents specified by the * `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java new file mode 100644 index 000000000..6da72cb0f --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -0,0 +1,1471 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** SignatureRequestEditEmbeddedRequest */ +@JsonPropertyOrder({ + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FILES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FIELD_OPTIONS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELD_GROUPS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELD_RULES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_HIDE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class SignatureRequestEditEmbeddedRequest { + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = null; + + public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + private List groupedSigners = null; + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + private Boolean allowReassign = false; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = null; + + public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + private List ccEmailAddresses = null; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + private SubFieldOptions fieldOptions; + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + private List formFieldGroups = null; + + public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + private List formFieldRules = null; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + private List formFieldsPerDocument = null; + + public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + private Boolean hideTextTags = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + private Boolean useTextTags = false; + + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = + "populate_auto_fill_fields"; + private Boolean populateAutoFillFields = false; + + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + private Integer expiresAt; + + public SignatureRequestEditEmbeddedRequest() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static SignatureRequestEditEmbeddedRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditEmbeddedRequest.class); + } + + public static SignatureRequestEditEmbeddedRequest init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditEmbeddedRequest.class); + } + + public SignatureRequestEditEmbeddedRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app you're using to create this embedded signature request. Used for + * security purposes. + * + * @return clientId + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getClientId() { + return clientId; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public SignatureRequestEditEmbeddedRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint + * requires either **files** or **file_urls[]**, but not both. + * + * @return files + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFiles() { + return files; + } + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + public SignatureRequestEditEmbeddedRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + * This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return fileUrls + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFileUrls() { + return fileUrls; + } + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + public SignatureRequestEditEmbeddedRequest signers(List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditEmbeddedRequest addSignersItem( + SubSignatureRequestSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or + * **grouped_signers**, but not both. + * + * @return signers + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getSigners() { + return signers; + } + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigners(List signers) { + this.signers = signers; + } + + public SignatureRequestEditEmbeddedRequest groupedSigners( + List groupedSigners) { + this.groupedSigners = groupedSigners; + return this; + } + + public SignatureRequestEditEmbeddedRequest addGroupedSignersItem( + SubSignatureRequestGroupedSigners groupedSignersItem) { + if (this.groupedSigners == null) { + this.groupedSigners = new ArrayList<>(); + } + this.groupedSigners.add(groupedSignersItem); + return this; + } + + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or + * **grouped_signers**, but not both. + * + * @return groupedSigners + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getGroupedSigners() { + return groupedSigners; + } + + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroupedSigners(List groupedSigners) { + this.groupedSigners = groupedSigners; + } + + public SignatureRequestEditEmbeddedRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to + * `false`. + * + * @return allowDecline + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowDecline() { + return allowDecline; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + public SignatureRequestEditEmbeddedRequest allowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + return this; + } + + /** + * Allows signers to reassign their signature requests to other signers if set to + * `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + * + * @return allowReassign + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowReassign() { + return allowReassign; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + } + + public SignatureRequestEditEmbeddedRequest attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public SignatureRequestEditEmbeddedRequest addAttachmentsItem(SubAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * A list describing the attachments + * + * @return attachments + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getAttachments() { + return attachments; + } + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + public SignatureRequestEditEmbeddedRequest ccEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + return this; + } + + public SignatureRequestEditEmbeddedRequest addCcEmailAddressesItem( + String ccEmailAddressesItem) { + if (this.ccEmailAddresses == null) { + this.ccEmailAddresses = new ArrayList<>(); + } + this.ccEmailAddresses.add(ccEmailAddressesItem); + return this; + } + + /** + * The email addresses that should be CCed. + * + * @return ccEmailAddresses + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCcEmailAddresses() { + return ccEmailAddresses; + } + + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + } + + public SignatureRequestEditEmbeddedRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditEmbeddedRequest addCustomFieldsItem( + SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * When used together with merge fields, `custom_fields` allows users to add + * pre-filled data to their signature requests. Pre-filled data can be used with + * \"send-once\" signature requests by adding merge fields with + * `form_fields_per_document` or [Text + * Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values + * back with `custom_fields` together in one API call. For using pre-filled on + * repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or + * by calling + * [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and + * then passing `custom_fields` on subsequent signature requests referencing that + * template. + * + * @return customFields + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCustomFields() { + return customFields; + } + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + public SignatureRequestEditEmbeddedRequest fieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + return this; + } + + /** + * Get fieldOptions + * + * @return fieldOptions + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubFieldOptions getFieldOptions() { + return fieldOptions; + } + + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + } + + public SignatureRequestEditEmbeddedRequest formFieldGroups( + List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldGroupsItem( + SubFormFieldGroup formFieldGroupsItem) { + if (this.formFieldGroups == null) { + this.formFieldGroups = new ArrayList<>(); + } + this.formFieldGroups.add(formFieldGroupsItem); + return this; + } + + /** + * Group information for fields defined in `form_fields_per_document`. String-indexed + * JSON array with `group_label` and `requirement` keys. + * `form_fields_per_document` must contain fields referencing a group defined in + * `form_field_groups`. + * + * @return formFieldGroups + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFormFieldGroups() { + return formFieldGroups; + } + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + public SignatureRequestEditEmbeddedRequest formFieldRules( + List formFieldRules) { + this.formFieldRules = formFieldRules; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldRulesItem( + SubFormFieldRule formFieldRulesItem) { + if (this.formFieldRules == null) { + this.formFieldRules = new ArrayList<>(); + } + this.formFieldRules.add(formFieldRulesItem); + return this; + } + + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + * + * @return formFieldRules + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFormFieldRules() { + return formFieldRules; + } + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + } + + public SignatureRequestEditEmbeddedRequest formFieldsPerDocument( + List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldsPerDocumentItem( + SubFormFieldsPerDocumentBase formFieldsPerDocumentItem) { + if (this.formFieldsPerDocument == null) { + this.formFieldsPerDocument = new ArrayList<>(); + } + this.formFieldsPerDocument.add(formFieldsPerDocumentItem); + return this; + } + + /** + * The fields that should appear on the document, expressed as an array of objects. (For more + * details you can read about it here: [Using Form Fields per + * Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, + * **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and + * optional parameters. Check out the list of [additional + * parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text + * Field use `SubFormFieldsPerDocumentText` * Dropdown Field use + * `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use + * `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use + * `SubFormFieldsPerDocumentCheckbox` * Radio Field use + * `SubFormFieldsPerDocumentRadio` * Signature Field use + * `SubFormFieldsPerDocumentSignature` * Date Signed Field use + * `SubFormFieldsPerDocumentDateSigned` * Initials Field use + * `SubFormFieldsPerDocumentInitials` * Text Merge Field use + * `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use + * `SubFormFieldsPerDocumentCheckboxMerge` + * + * @return formFieldsPerDocument + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldsPerDocument(List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + public SignatureRequestEditEmbeddedRequest hideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + return this; + } + + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way + * can cause unwanted clipping. We recommend leaving this setting on `false` and + * instead hiding your text tags using white text or a similar approach. See the [Text Tags + * Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more + * information. + * + * @return hideTextTags + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getHideTextTags() { + return hideTextTags; + } + + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + } + + public SignatureRequestEditEmbeddedRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * + * @return message + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getMessage() { + return message; + } + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + public SignatureRequestEditEmbeddedRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditEmbeddedRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in + * all API responses and events involving the signature request. For example, use the metadata + * field to store a signer's order number for look up when receiving events for the + * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata + * keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return metadata + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public Map getMetadata() { + return metadata; + } + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + public SignatureRequestEditEmbeddedRequest signingOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * + * @return signingOptions + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + public SignatureRequestEditEmbeddedRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * + * @return subject + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSubject() { + return subject; + } + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + public SignatureRequestEditEmbeddedRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to + * `true`. Defaults to `false`. + * + * @return testMode + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getTestMode() { + return testMode; + } + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + public SignatureRequestEditEmbeddedRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * + * @return title + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getTitle() { + return title; + } + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + public SignatureRequestEditEmbeddedRequest useTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [Text + * Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your + * document. Defaults to disabled, or `false`. + * + * @return useTextTags + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getUseTextTags() { + return useTextTags; + } + + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUseTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + } + + public SignatureRequestEditEmbeddedRequest populateAutoFillFields( + Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + return this; + } + + /** + * Controls whether [auto fill + * fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can + * automatically populate a signer's information during signing. **NOTE:** Keep your + * signer's information safe by ensuring that the _signer on your signature request is the + * intended party_ before using this feature. + * + * @return populateAutoFillFields + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getPopulateAutoFillFields() { + return populateAutoFillFields; + } + + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + } + + public SignatureRequestEditEmbeddedRequest expiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * When the signature request will expire. Unsigned signatures will be moved to the expired + * status, and no longer signable. See [Signature Request Expiration + * Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * + * @return expiresAt + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getExpiresAt() { + return expiresAt; + } + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + } + + /** Return true if this SignatureRequestEditEmbeddedRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest = + (SignatureRequestEditEmbeddedRequest) o; + return Objects.equals(this.clientId, signatureRequestEditEmbeddedRequest.clientId) + && Objects.equals(this.files, signatureRequestEditEmbeddedRequest.files) + && Objects.equals(this.fileUrls, signatureRequestEditEmbeddedRequest.fileUrls) + && Objects.equals(this.signers, signatureRequestEditEmbeddedRequest.signers) + && Objects.equals( + this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) + && Objects.equals( + this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) + && Objects.equals( + this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) + && Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) + && Objects.equals( + this.ccEmailAddresses, signatureRequestEditEmbeddedRequest.ccEmailAddresses) + && Objects.equals( + this.customFields, signatureRequestEditEmbeddedRequest.customFields) + && Objects.equals( + this.fieldOptions, signatureRequestEditEmbeddedRequest.fieldOptions) + && Objects.equals( + this.formFieldGroups, signatureRequestEditEmbeddedRequest.formFieldGroups) + && Objects.equals( + this.formFieldRules, signatureRequestEditEmbeddedRequest.formFieldRules) + && Objects.equals( + this.formFieldsPerDocument, + signatureRequestEditEmbeddedRequest.formFieldsPerDocument) + && Objects.equals( + this.hideTextTags, signatureRequestEditEmbeddedRequest.hideTextTags) + && Objects.equals(this.message, signatureRequestEditEmbeddedRequest.message) + && Objects.equals(this.metadata, signatureRequestEditEmbeddedRequest.metadata) + && Objects.equals( + this.signingOptions, signatureRequestEditEmbeddedRequest.signingOptions) + && Objects.equals(this.subject, signatureRequestEditEmbeddedRequest.subject) + && Objects.equals(this.testMode, signatureRequestEditEmbeddedRequest.testMode) + && Objects.equals(this.title, signatureRequestEditEmbeddedRequest.title) + && Objects.equals(this.useTextTags, signatureRequestEditEmbeddedRequest.useTextTags) + && Objects.equals( + this.populateAutoFillFields, + signatureRequestEditEmbeddedRequest.populateAutoFillFields) + && Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt); + } + + @Override + public int hashCode() { + return Objects.hash( + clientId, + files, + fileUrls, + signers, + groupedSigners, + allowDecline, + allowReassign, + attachments, + ccEmailAddresses, + customFields, + fieldOptions, + formFieldGroups, + formFieldRules, + formFieldsPerDocument, + hideTextTags, + message, + metadata, + signingOptions, + subject, + testMode, + title, + useTextTags, + populateAutoFillFields, + expiresAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditEmbeddedRequest {\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" fieldOptions: ").append(toIndentedString(fieldOptions)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" formFieldRules: ").append(toIndentedString(formFieldRules)).append("\n"); + sb.append(" formFieldsPerDocument: ") + .append(toIndentedString(formFieldsPerDocument)) + .append("\n"); + sb.append(" hideTextTags: ").append(toIndentedString(hideTextTags)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" populateAutoFillFields: ") + .append(toIndentedString(populateAutoFillFields)) + .append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) + || clientId.getClass().equals(Integer.class) + || clientId.getClass().equals(String.class) + || clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for (int i = 0; i < getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } else { + map.put( + "client_id", + JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) + || files.getClass().equals(Integer.class) + || files.getClass().equals(String.class) + || files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for (int i = 0; i < getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) + || fileUrls.getClass().equals(Integer.class) + || fileUrls.getClass().equals(String.class) + || fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for (int i = 0; i < getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } else { + map.put( + "file_urls", + JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) + || signers.getClass().equals(Integer.class) + || signers.getClass().equals(String.class) + || signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for (int i = 0; i < getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (groupedSigners != null) { + if (isFileTypeOrListOfFiles(groupedSigners)) { + fileTypeFound = true; + } + + if (groupedSigners.getClass().equals(java.io.File.class) + || groupedSigners.getClass().equals(Integer.class) + || groupedSigners.getClass().equals(String.class) + || groupedSigners.getClass().isEnum()) { + map.put("grouped_signers", groupedSigners); + } else if (isListOfFile(groupedSigners)) { + for (int i = 0; i < getListSize(groupedSigners); i++) { + map.put("grouped_signers[" + i + "]", getFromList(groupedSigners, i)); + } + } else { + map.put( + "grouped_signers", + JSON.getDefault().getMapper().writeValueAsString(groupedSigners)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) + || allowDecline.getClass().equals(Integer.class) + || allowDecline.getClass().equals(String.class) + || allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for (int i = 0; i < getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } else { + map.put( + "allow_decline", + JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (allowReassign != null) { + if (isFileTypeOrListOfFiles(allowReassign)) { + fileTypeFound = true; + } + + if (allowReassign.getClass().equals(java.io.File.class) + || allowReassign.getClass().equals(Integer.class) + || allowReassign.getClass().equals(String.class) + || allowReassign.getClass().isEnum()) { + map.put("allow_reassign", allowReassign); + } else if (isListOfFile(allowReassign)) { + for (int i = 0; i < getListSize(allowReassign); i++) { + map.put("allow_reassign[" + i + "]", getFromList(allowReassign, i)); + } + } else { + map.put( + "allow_reassign", + JSON.getDefault().getMapper().writeValueAsString(allowReassign)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) + || attachments.getClass().equals(Integer.class) + || attachments.getClass().equals(String.class) + || attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for (int i = 0; i < getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } else { + map.put( + "attachments", + JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (ccEmailAddresses != null) { + if (isFileTypeOrListOfFiles(ccEmailAddresses)) { + fileTypeFound = true; + } + + if (ccEmailAddresses.getClass().equals(java.io.File.class) + || ccEmailAddresses.getClass().equals(Integer.class) + || ccEmailAddresses.getClass().equals(String.class) + || ccEmailAddresses.getClass().isEnum()) { + map.put("cc_email_addresses", ccEmailAddresses); + } else if (isListOfFile(ccEmailAddresses)) { + for (int i = 0; i < getListSize(ccEmailAddresses); i++) { + map.put("cc_email_addresses[" + i + "]", getFromList(ccEmailAddresses, i)); + } + } else { + map.put( + "cc_email_addresses", + JSON.getDefault().getMapper().writeValueAsString(ccEmailAddresses)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) + || customFields.getClass().equals(Integer.class) + || customFields.getClass().equals(String.class) + || customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for (int i = 0; i < getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } else { + map.put( + "custom_fields", + JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (fieldOptions != null) { + if (isFileTypeOrListOfFiles(fieldOptions)) { + fileTypeFound = true; + } + + if (fieldOptions.getClass().equals(java.io.File.class) + || fieldOptions.getClass().equals(Integer.class) + || fieldOptions.getClass().equals(String.class) + || fieldOptions.getClass().isEnum()) { + map.put("field_options", fieldOptions); + } else if (isListOfFile(fieldOptions)) { + for (int i = 0; i < getListSize(fieldOptions); i++) { + map.put("field_options[" + i + "]", getFromList(fieldOptions, i)); + } + } else { + map.put( + "field_options", + JSON.getDefault().getMapper().writeValueAsString(fieldOptions)); + } + } + if (formFieldGroups != null) { + if (isFileTypeOrListOfFiles(formFieldGroups)) { + fileTypeFound = true; + } + + if (formFieldGroups.getClass().equals(java.io.File.class) + || formFieldGroups.getClass().equals(Integer.class) + || formFieldGroups.getClass().equals(String.class) + || formFieldGroups.getClass().isEnum()) { + map.put("form_field_groups", formFieldGroups); + } else if (isListOfFile(formFieldGroups)) { + for (int i = 0; i < getListSize(formFieldGroups); i++) { + map.put("form_field_groups[" + i + "]", getFromList(formFieldGroups, i)); + } + } else { + map.put( + "form_field_groups", + JSON.getDefault().getMapper().writeValueAsString(formFieldGroups)); + } + } + if (formFieldRules != null) { + if (isFileTypeOrListOfFiles(formFieldRules)) { + fileTypeFound = true; + } + + if (formFieldRules.getClass().equals(java.io.File.class) + || formFieldRules.getClass().equals(Integer.class) + || formFieldRules.getClass().equals(String.class) + || formFieldRules.getClass().isEnum()) { + map.put("form_field_rules", formFieldRules); + } else if (isListOfFile(formFieldRules)) { + for (int i = 0; i < getListSize(formFieldRules); i++) { + map.put("form_field_rules[" + i + "]", getFromList(formFieldRules, i)); + } + } else { + map.put( + "form_field_rules", + JSON.getDefault().getMapper().writeValueAsString(formFieldRules)); + } + } + if (formFieldsPerDocument != null) { + if (isFileTypeOrListOfFiles(formFieldsPerDocument)) { + fileTypeFound = true; + } + + if (formFieldsPerDocument.getClass().equals(java.io.File.class) + || formFieldsPerDocument.getClass().equals(Integer.class) + || formFieldsPerDocument.getClass().equals(String.class) + || formFieldsPerDocument.getClass().isEnum()) { + map.put("form_fields_per_document", formFieldsPerDocument); + } else if (isListOfFile(formFieldsPerDocument)) { + for (int i = 0; i < getListSize(formFieldsPerDocument); i++) { + map.put( + "form_fields_per_document[" + i + "]", + getFromList(formFieldsPerDocument, i)); + } + } else { + map.put( + "form_fields_per_document", + JSON.getDefault() + .getMapper() + .writeValueAsString(formFieldsPerDocument)); + } + } + if (hideTextTags != null) { + if (isFileTypeOrListOfFiles(hideTextTags)) { + fileTypeFound = true; + } + + if (hideTextTags.getClass().equals(java.io.File.class) + || hideTextTags.getClass().equals(Integer.class) + || hideTextTags.getClass().equals(String.class) + || hideTextTags.getClass().isEnum()) { + map.put("hide_text_tags", hideTextTags); + } else if (isListOfFile(hideTextTags)) { + for (int i = 0; i < getListSize(hideTextTags); i++) { + map.put("hide_text_tags[" + i + "]", getFromList(hideTextTags, i)); + } + } else { + map.put( + "hide_text_tags", + JSON.getDefault().getMapper().writeValueAsString(hideTextTags)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) + || message.getClass().equals(Integer.class) + || message.getClass().equals(String.class) + || message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for (int i = 0; i < getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) + || metadata.getClass().equals(Integer.class) + || metadata.getClass().equals(String.class) + || metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for (int i = 0; i < getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) + || signingOptions.getClass().equals(Integer.class) + || signingOptions.getClass().equals(String.class) + || signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for (int i = 0; i < getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } else { + map.put( + "signing_options", + JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) + || subject.getClass().equals(Integer.class) + || subject.getClass().equals(String.class) + || subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for (int i = 0; i < getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) + || testMode.getClass().equals(Integer.class) + || testMode.getClass().equals(String.class) + || testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for (int i = 0; i < getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } else { + map.put( + "test_mode", + JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) + || title.getClass().equals(Integer.class) + || title.getClass().equals(String.class) + || title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for (int i = 0; i < getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (useTextTags != null) { + if (isFileTypeOrListOfFiles(useTextTags)) { + fileTypeFound = true; + } + + if (useTextTags.getClass().equals(java.io.File.class) + || useTextTags.getClass().equals(Integer.class) + || useTextTags.getClass().equals(String.class) + || useTextTags.getClass().isEnum()) { + map.put("use_text_tags", useTextTags); + } else if (isListOfFile(useTextTags)) { + for (int i = 0; i < getListSize(useTextTags); i++) { + map.put("use_text_tags[" + i + "]", getFromList(useTextTags, i)); + } + } else { + map.put( + "use_text_tags", + JSON.getDefault().getMapper().writeValueAsString(useTextTags)); + } + } + if (populateAutoFillFields != null) { + if (isFileTypeOrListOfFiles(populateAutoFillFields)) { + fileTypeFound = true; + } + + if (populateAutoFillFields.getClass().equals(java.io.File.class) + || populateAutoFillFields.getClass().equals(Integer.class) + || populateAutoFillFields.getClass().equals(String.class) + || populateAutoFillFields.getClass().isEnum()) { + map.put("populate_auto_fill_fields", populateAutoFillFields); + } else if (isListOfFile(populateAutoFillFields)) { + for (int i = 0; i < getListSize(populateAutoFillFields); i++) { + map.put( + "populate_auto_fill_fields[" + i + "]", + getFromList(populateAutoFillFields, i)); + } + } else { + map.put( + "populate_auto_fill_fields", + JSON.getDefault() + .getMapper() + .writeValueAsString(populateAutoFillFields)); + } + } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) + || expiresAt.getClass().equals(Integer.class) + || expiresAt.getClass().equals(String.class) + || expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for (int i = 0; i < getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } else { + map.put( + "expires_at", + JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java new file mode 100644 index 000000000..03e4cccf7 --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -0,0 +1,958 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** SignatureRequestEditEmbeddedWithTemplateRequest */ +@JsonPropertyOrder({ + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEMPLATE_IDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CCS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_FILES, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class SignatureRequestEditEmbeddedWithTemplateRequest { + public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + private List templateIds = new ArrayList<>(); + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = new ArrayList<>(); + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_CCS = "ccs"; + private List ccs = null; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = + "populate_auto_fill_fields"; + private Boolean populateAutoFillFields = false; + + public SignatureRequestEditEmbeddedWithTemplateRequest() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static SignatureRequestEditEmbeddedWithTemplateRequest init(String jsonData) + throws Exception { + return new ObjectMapper() + .readValue(jsonData, SignatureRequestEditEmbeddedWithTemplateRequest.class); + } + + public static SignatureRequestEditEmbeddedWithTemplateRequest init(HashMap data) + throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditEmbeddedWithTemplateRequest.class); + } + + public SignatureRequestEditEmbeddedWithTemplateRequest templateIds(List templateIds) { + this.templateIds = templateIds; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addTemplateIdsItem( + String templateIdsItem) { + if (this.templateIds == null) { + this.templateIds = new ArrayList<>(); + } + this.templateIds.add(templateIdsItem); + return this; + } + + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the + * order in which the template will be used. + * + * @return templateIds + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getTemplateIds() { + return templateIds; + } + + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateIds(List templateIds) { + this.templateIds = templateIds; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app you're using to create this embedded signature request. Used for + * security purposes. + * + * @return clientId + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getClientId() { + return clientId; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest signers( + List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addSignersItem( + SubSignatureRequestTemplateSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Templated-based Signature Request. + * + * @return signers + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getSigners() { + return signers; + } + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSigners(List signers) { + this.signers = signers; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to + * `false`. + * + * @return allowDecline + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowDecline() { + return allowDecline; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addCcsItem(SubCC ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList<>(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * Add CC email recipients. Required when a CC role exists for the Template. + * + * @return ccs + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCcs() { + return ccs; + } + + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest customFields( + List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addCustomFieldsItem( + SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * An array defining values and options for custom fields. Required when a custom field exists + * in the Template. + * + * @return customFields + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCustomFields() { + return customFields; + } + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint + * requires either **files** or **file_urls[]**, but not both. + * + * @return files + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFiles() { + return files; + } + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + * This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return fileUrls + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFileUrls() { + return fileUrls; + } + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * + * @return message + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getMessage() { + return message; + } + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest putMetadataItem( + String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in + * all API responses and events involving the signature request. For example, use the metadata + * field to store a signer's order number for look up when receiving events for the + * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata + * keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return metadata + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public Map getMetadata() { + return metadata; + } + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest signingOptions( + SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * + * @return signingOptions + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * + * @return subject + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSubject() { + return subject; + } + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to + * `true`. Defaults to `false`. + * + * @return testMode + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getTestMode() { + return testMode; + } + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * + * @return title + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getTitle() { + return title; + } + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest populateAutoFillFields( + Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + return this; + } + + /** + * Controls whether [auto fill + * fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can + * automatically populate a signer's information during signing. **NOTE:** Keep your + * signer's information safe by ensuring that the _signer on your signature request is the + * intended party_ before using this feature. + * + * @return populateAutoFillFields + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getPopulateAutoFillFields() { + return populateAutoFillFields; + } + + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + } + + /** Return true if this SignatureRequestEditEmbeddedWithTemplateRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditEmbeddedWithTemplateRequest + signatureRequestEditEmbeddedWithTemplateRequest = + (SignatureRequestEditEmbeddedWithTemplateRequest) o; + return Objects.equals( + this.templateIds, + signatureRequestEditEmbeddedWithTemplateRequest.templateIds) + && Objects.equals( + this.clientId, signatureRequestEditEmbeddedWithTemplateRequest.clientId) + && Objects.equals( + this.signers, signatureRequestEditEmbeddedWithTemplateRequest.signers) + && Objects.equals( + this.allowDecline, + signatureRequestEditEmbeddedWithTemplateRequest.allowDecline) + && Objects.equals(this.ccs, signatureRequestEditEmbeddedWithTemplateRequest.ccs) + && Objects.equals( + this.customFields, + signatureRequestEditEmbeddedWithTemplateRequest.customFields) + && Objects.equals(this.files, signatureRequestEditEmbeddedWithTemplateRequest.files) + && Objects.equals( + this.fileUrls, signatureRequestEditEmbeddedWithTemplateRequest.fileUrls) + && Objects.equals( + this.message, signatureRequestEditEmbeddedWithTemplateRequest.message) + && Objects.equals( + this.metadata, signatureRequestEditEmbeddedWithTemplateRequest.metadata) + && Objects.equals( + this.signingOptions, + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions) + && Objects.equals( + this.subject, signatureRequestEditEmbeddedWithTemplateRequest.subject) + && Objects.equals( + this.testMode, signatureRequestEditEmbeddedWithTemplateRequest.testMode) + && Objects.equals(this.title, signatureRequestEditEmbeddedWithTemplateRequest.title) + && Objects.equals( + this.populateAutoFillFields, + signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields); + } + + @Override + public int hashCode() { + return Objects.hash( + templateIds, + clientId, + signers, + allowDecline, + ccs, + customFields, + files, + fileUrls, + message, + metadata, + signingOptions, + subject, + testMode, + title, + populateAutoFillFields); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditEmbeddedWithTemplateRequest {\n"); + sb.append(" templateIds: ").append(toIndentedString(templateIds)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" populateAutoFillFields: ") + .append(toIndentedString(populateAutoFillFields)) + .append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (templateIds != null) { + if (isFileTypeOrListOfFiles(templateIds)) { + fileTypeFound = true; + } + + if (templateIds.getClass().equals(java.io.File.class) + || templateIds.getClass().equals(Integer.class) + || templateIds.getClass().equals(String.class) + || templateIds.getClass().isEnum()) { + map.put("template_ids", templateIds); + } else if (isListOfFile(templateIds)) { + for (int i = 0; i < getListSize(templateIds); i++) { + map.put("template_ids[" + i + "]", getFromList(templateIds, i)); + } + } else { + map.put( + "template_ids", + JSON.getDefault().getMapper().writeValueAsString(templateIds)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) + || clientId.getClass().equals(Integer.class) + || clientId.getClass().equals(String.class) + || clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for (int i = 0; i < getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } else { + map.put( + "client_id", + JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) + || signers.getClass().equals(Integer.class) + || signers.getClass().equals(String.class) + || signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for (int i = 0; i < getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) + || allowDecline.getClass().equals(Integer.class) + || allowDecline.getClass().equals(String.class) + || allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for (int i = 0; i < getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } else { + map.put( + "allow_decline", + JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (ccs != null) { + if (isFileTypeOrListOfFiles(ccs)) { + fileTypeFound = true; + } + + if (ccs.getClass().equals(java.io.File.class) + || ccs.getClass().equals(Integer.class) + || ccs.getClass().equals(String.class) + || ccs.getClass().isEnum()) { + map.put("ccs", ccs); + } else if (isListOfFile(ccs)) { + for (int i = 0; i < getListSize(ccs); i++) { + map.put("ccs[" + i + "]", getFromList(ccs, i)); + } + } else { + map.put("ccs", JSON.getDefault().getMapper().writeValueAsString(ccs)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) + || customFields.getClass().equals(Integer.class) + || customFields.getClass().equals(String.class) + || customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for (int i = 0; i < getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } else { + map.put( + "custom_fields", + JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) + || files.getClass().equals(Integer.class) + || files.getClass().equals(String.class) + || files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for (int i = 0; i < getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) + || fileUrls.getClass().equals(Integer.class) + || fileUrls.getClass().equals(String.class) + || fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for (int i = 0; i < getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } else { + map.put( + "file_urls", + JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) + || message.getClass().equals(Integer.class) + || message.getClass().equals(String.class) + || message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for (int i = 0; i < getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) + || metadata.getClass().equals(Integer.class) + || metadata.getClass().equals(String.class) + || metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for (int i = 0; i < getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) + || signingOptions.getClass().equals(Integer.class) + || signingOptions.getClass().equals(String.class) + || signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for (int i = 0; i < getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } else { + map.put( + "signing_options", + JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) + || subject.getClass().equals(Integer.class) + || subject.getClass().equals(String.class) + || subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for (int i = 0; i < getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) + || testMode.getClass().equals(Integer.class) + || testMode.getClass().equals(String.class) + || testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for (int i = 0; i < getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } else { + map.put( + "test_mode", + JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) + || title.getClass().equals(Integer.class) + || title.getClass().equals(String.class) + || title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for (int i = 0; i < getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (populateAutoFillFields != null) { + if (isFileTypeOrListOfFiles(populateAutoFillFields)) { + fileTypeFound = true; + } + + if (populateAutoFillFields.getClass().equals(java.io.File.class) + || populateAutoFillFields.getClass().equals(Integer.class) + || populateAutoFillFields.getClass().equals(String.class) + || populateAutoFillFields.getClass().isEnum()) { + map.put("populate_auto_fill_fields", populateAutoFillFields); + } else if (isListOfFile(populateAutoFillFields)) { + for (int i = 0; i < getListSize(populateAutoFillFields); i++) { + map.put( + "populate_auto_fill_fields[" + i + "]", + getFromList(populateAutoFillFields, i)); + } + } else { + map.put( + "populate_auto_fill_fields", + JSON.getDefault() + .getMapper() + .writeValueAsString(populateAutoFillFields)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java new file mode 100644 index 000000000..92427a9db --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -0,0 +1,1497 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** SignatureRequestEditRequest */ +@JsonPropertyOrder({ + SignatureRequestEditRequest.JSON_PROPERTY_FILES, + SignatureRequestEditRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, + SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, + SignatureRequestEditRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditRequest.JSON_PROPERTY_FIELD_OPTIONS, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELD_GROUPS, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELD_RULES, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + SignatureRequestEditRequest.JSON_PROPERTY_HIDE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_IS_EID, + SignatureRequestEditRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, + SignatureRequestEditRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class SignatureRequestEditRequest { + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = null; + + public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + private List groupedSigners = null; + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + private Boolean allowReassign = false; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = null; + + public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + private List ccEmailAddresses = null; + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + private SubFieldOptions fieldOptions; + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + private List formFieldGroups = null; + + public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + private List formFieldRules = null; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + private List formFieldsPerDocument = null; + + public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + private Boolean hideTextTags = false; + + public static final String JSON_PROPERTY_IS_EID = "is_eid"; + private Boolean isEid = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + private String signingRedirectUrl; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + private Boolean useTextTags = false; + + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + private Integer expiresAt; + + public SignatureRequestEditRequest() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static SignatureRequestEditRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditRequest.class); + } + + public static SignatureRequestEditRequest init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditRequest.class); + } + + public SignatureRequestEditRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint + * requires either **files** or **file_urls[]**, but not both. + * + * @return files + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFiles() { + return files; + } + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + public SignatureRequestEditRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + * This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return fileUrls + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFileUrls() { + return fileUrls; + } + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + public SignatureRequestEditRequest signers(List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditRequest addSignersItem(SubSignatureRequestSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or + * **grouped_signers**, but not both. + * + * @return signers + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getSigners() { + return signers; + } + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigners(List signers) { + this.signers = signers; + } + + public SignatureRequestEditRequest groupedSigners( + List groupedSigners) { + this.groupedSigners = groupedSigners; + return this; + } + + public SignatureRequestEditRequest addGroupedSignersItem( + SubSignatureRequestGroupedSigners groupedSignersItem) { + if (this.groupedSigners == null) { + this.groupedSigners = new ArrayList<>(); + } + this.groupedSigners.add(groupedSignersItem); + return this; + } + + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or + * **grouped_signers**, but not both. + * + * @return groupedSigners + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getGroupedSigners() { + return groupedSigners; + } + + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroupedSigners(List groupedSigners) { + this.groupedSigners = groupedSigners; + } + + public SignatureRequestEditRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to + * `false`. + * + * @return allowDecline + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowDecline() { + return allowDecline; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + public SignatureRequestEditRequest allowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + return this; + } + + /** + * Allows signers to reassign their signature requests to other signers if set to + * `true`. Defaults to `false`. **NOTE:** Only available for Premium plan + * and higher. + * + * @return allowReassign + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowReassign() { + return allowReassign; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + } + + public SignatureRequestEditRequest attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public SignatureRequestEditRequest addAttachmentsItem(SubAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * A list describing the attachments + * + * @return attachments + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getAttachments() { + return attachments; + } + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + public SignatureRequestEditRequest ccEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + return this; + } + + public SignatureRequestEditRequest addCcEmailAddressesItem(String ccEmailAddressesItem) { + if (this.ccEmailAddresses == null) { + this.ccEmailAddresses = new ArrayList<>(); + } + this.ccEmailAddresses.add(ccEmailAddressesItem); + return this; + } + + /** + * The email addresses that should be CCed. + * + * @return ccEmailAddresses + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCcEmailAddresses() { + return ccEmailAddresses; + } + + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + } + + public SignatureRequestEditRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client id of the API App you want to associate with this request. Used to apply the + * branding and callback url defined for the app. + * + * @return clientId + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getClientId() { + return clientId; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public SignatureRequestEditRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * When used together with merge fields, `custom_fields` allows users to add + * pre-filled data to their signature requests. Pre-filled data can be used with + * \"send-once\" signature requests by adding merge fields with + * `form_fields_per_document` or [Text + * Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values + * back with `custom_fields` together in one API call. For using pre-filled on + * repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or + * by calling + * [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and + * then passing `custom_fields` on subsequent signature requests referencing that + * template. + * + * @return customFields + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCustomFields() { + return customFields; + } + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + public SignatureRequestEditRequest fieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + return this; + } + + /** + * Get fieldOptions + * + * @return fieldOptions + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubFieldOptions getFieldOptions() { + return fieldOptions; + } + + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + } + + public SignatureRequestEditRequest formFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public SignatureRequestEditRequest addFormFieldGroupsItem( + SubFormFieldGroup formFieldGroupsItem) { + if (this.formFieldGroups == null) { + this.formFieldGroups = new ArrayList<>(); + } + this.formFieldGroups.add(formFieldGroupsItem); + return this; + } + + /** + * Group information for fields defined in `form_fields_per_document`. String-indexed + * JSON array with `group_label` and `requirement` keys. + * `form_fields_per_document` must contain fields referencing a group defined in + * `form_field_groups`. + * + * @return formFieldGroups + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFormFieldGroups() { + return formFieldGroups; + } + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + public SignatureRequestEditRequest formFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + return this; + } + + public SignatureRequestEditRequest addFormFieldRulesItem(SubFormFieldRule formFieldRulesItem) { + if (this.formFieldRules == null) { + this.formFieldRules = new ArrayList<>(); + } + this.formFieldRules.add(formFieldRulesItem); + return this; + } + + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + * + * @return formFieldRules + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFormFieldRules() { + return formFieldRules; + } + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + } + + public SignatureRequestEditRequest formFieldsPerDocument( + List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public SignatureRequestEditRequest addFormFieldsPerDocumentItem( + SubFormFieldsPerDocumentBase formFieldsPerDocumentItem) { + if (this.formFieldsPerDocument == null) { + this.formFieldsPerDocument = new ArrayList<>(); + } + this.formFieldsPerDocument.add(formFieldsPerDocumentItem); + return this; + } + + /** + * The fields that should appear on the document, expressed as an array of objects. (For more + * details you can read about it here: [Using Form Fields per + * Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, + * **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and + * optional parameters. Check out the list of [additional + * parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text + * Field use `SubFormFieldsPerDocumentText` * Dropdown Field use + * `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use + * `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use + * `SubFormFieldsPerDocumentCheckbox` * Radio Field use + * `SubFormFieldsPerDocumentRadio` * Signature Field use + * `SubFormFieldsPerDocumentSignature` * Date Signed Field use + * `SubFormFieldsPerDocumentDateSigned` * Initials Field use + * `SubFormFieldsPerDocumentInitials` * Text Merge Field use + * `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use + * `SubFormFieldsPerDocumentCheckboxMerge` + * + * @return formFieldsPerDocument + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldsPerDocument(List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + public SignatureRequestEditRequest hideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + return this; + } + + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way + * can cause unwanted clipping. We recommend leaving this setting on `false` and + * instead hiding your text tags using white text or a similar approach. See the [Text Tags + * Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more + * information. + * + * @return hideTextTags + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getHideTextTags() { + return hideTextTags; + } + + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + } + + public SignatureRequestEditRequest isEid(Boolean isEid) { + this.isEid = isEid; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [electronic identification + * (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify + * their identity with an eID provider to sign a document.<br> **NOTE:** eID is only + * available on the Premium API plan. Cannot be used in `test_mode`. Only works on + * requests with one signer. + * + * @return isEid + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIsEid() { + return isEid; + } + + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEid(Boolean isEid) { + this.isEid = isEid; + } + + public SignatureRequestEditRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * + * @return message + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getMessage() { + return message; + } + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + public SignatureRequestEditRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in + * all API responses and events involving the signature request. For example, use the metadata + * field to store a signer's order number for look up when receiving events for the + * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata + * keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return metadata + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public Map getMetadata() { + return metadata; + } + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + public SignatureRequestEditRequest signingOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * + * @return signingOptions + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + public SignatureRequestEditRequest signingRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + return this; + } + + /** + * The URL you want signers redirected to after they successfully sign. + * + * @return signingRedirectUrl + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSigningRedirectUrl() { + return signingRedirectUrl; + } + + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + } + + public SignatureRequestEditRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * + * @return subject + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSubject() { + return subject; + } + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + public SignatureRequestEditRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to + * `true`. Defaults to `false`. + * + * @return testMode + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getTestMode() { + return testMode; + } + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + public SignatureRequestEditRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * + * @return title + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getTitle() { + return title; + } + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + public SignatureRequestEditRequest useTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [Text + * Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your + * document. Defaults to disabled, or `false`. + * + * @return useTextTags + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getUseTextTags() { + return useTextTags; + } + + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUseTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + } + + public SignatureRequestEditRequest expiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * When the signature request will expire. Unsigned signatures will be moved to the expired + * status, and no longer signable. See [Signature Request Expiration + * Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * + * @return expiresAt + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getExpiresAt() { + return expiresAt; + } + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + } + + /** Return true if this SignatureRequestEditRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditRequest signatureRequestEditRequest = (SignatureRequestEditRequest) o; + return Objects.equals(this.files, signatureRequestEditRequest.files) + && Objects.equals(this.fileUrls, signatureRequestEditRequest.fileUrls) + && Objects.equals(this.signers, signatureRequestEditRequest.signers) + && Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) + && Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) + && Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) + && Objects.equals(this.attachments, signatureRequestEditRequest.attachments) + && Objects.equals( + this.ccEmailAddresses, signatureRequestEditRequest.ccEmailAddresses) + && Objects.equals(this.clientId, signatureRequestEditRequest.clientId) + && Objects.equals(this.customFields, signatureRequestEditRequest.customFields) + && Objects.equals(this.fieldOptions, signatureRequestEditRequest.fieldOptions) + && Objects.equals(this.formFieldGroups, signatureRequestEditRequest.formFieldGroups) + && Objects.equals(this.formFieldRules, signatureRequestEditRequest.formFieldRules) + && Objects.equals( + this.formFieldsPerDocument, + signatureRequestEditRequest.formFieldsPerDocument) + && Objects.equals(this.hideTextTags, signatureRequestEditRequest.hideTextTags) + && Objects.equals(this.isEid, signatureRequestEditRequest.isEid) + && Objects.equals(this.message, signatureRequestEditRequest.message) + && Objects.equals(this.metadata, signatureRequestEditRequest.metadata) + && Objects.equals(this.signingOptions, signatureRequestEditRequest.signingOptions) + && Objects.equals( + this.signingRedirectUrl, signatureRequestEditRequest.signingRedirectUrl) + && Objects.equals(this.subject, signatureRequestEditRequest.subject) + && Objects.equals(this.testMode, signatureRequestEditRequest.testMode) + && Objects.equals(this.title, signatureRequestEditRequest.title) + && Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) + && Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); + } + + @Override + public int hashCode() { + return Objects.hash( + files, + fileUrls, + signers, + groupedSigners, + allowDecline, + allowReassign, + attachments, + ccEmailAddresses, + clientId, + customFields, + fieldOptions, + formFieldGroups, + formFieldRules, + formFieldsPerDocument, + hideTextTags, + isEid, + message, + metadata, + signingOptions, + signingRedirectUrl, + subject, + testMode, + title, + useTextTags, + expiresAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditRequest {\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" fieldOptions: ").append(toIndentedString(fieldOptions)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" formFieldRules: ").append(toIndentedString(formFieldRules)).append("\n"); + sb.append(" formFieldsPerDocument: ") + .append(toIndentedString(formFieldsPerDocument)) + .append("\n"); + sb.append(" hideTextTags: ").append(toIndentedString(hideTextTags)).append("\n"); + sb.append(" isEid: ").append(toIndentedString(isEid)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" signingRedirectUrl: ") + .append(toIndentedString(signingRedirectUrl)) + .append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) + || files.getClass().equals(Integer.class) + || files.getClass().equals(String.class) + || files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for (int i = 0; i < getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) + || fileUrls.getClass().equals(Integer.class) + || fileUrls.getClass().equals(String.class) + || fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for (int i = 0; i < getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } else { + map.put( + "file_urls", + JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) + || signers.getClass().equals(Integer.class) + || signers.getClass().equals(String.class) + || signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for (int i = 0; i < getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (groupedSigners != null) { + if (isFileTypeOrListOfFiles(groupedSigners)) { + fileTypeFound = true; + } + + if (groupedSigners.getClass().equals(java.io.File.class) + || groupedSigners.getClass().equals(Integer.class) + || groupedSigners.getClass().equals(String.class) + || groupedSigners.getClass().isEnum()) { + map.put("grouped_signers", groupedSigners); + } else if (isListOfFile(groupedSigners)) { + for (int i = 0; i < getListSize(groupedSigners); i++) { + map.put("grouped_signers[" + i + "]", getFromList(groupedSigners, i)); + } + } else { + map.put( + "grouped_signers", + JSON.getDefault().getMapper().writeValueAsString(groupedSigners)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) + || allowDecline.getClass().equals(Integer.class) + || allowDecline.getClass().equals(String.class) + || allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for (int i = 0; i < getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } else { + map.put( + "allow_decline", + JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (allowReassign != null) { + if (isFileTypeOrListOfFiles(allowReassign)) { + fileTypeFound = true; + } + + if (allowReassign.getClass().equals(java.io.File.class) + || allowReassign.getClass().equals(Integer.class) + || allowReassign.getClass().equals(String.class) + || allowReassign.getClass().isEnum()) { + map.put("allow_reassign", allowReassign); + } else if (isListOfFile(allowReassign)) { + for (int i = 0; i < getListSize(allowReassign); i++) { + map.put("allow_reassign[" + i + "]", getFromList(allowReassign, i)); + } + } else { + map.put( + "allow_reassign", + JSON.getDefault().getMapper().writeValueAsString(allowReassign)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) + || attachments.getClass().equals(Integer.class) + || attachments.getClass().equals(String.class) + || attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for (int i = 0; i < getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } else { + map.put( + "attachments", + JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (ccEmailAddresses != null) { + if (isFileTypeOrListOfFiles(ccEmailAddresses)) { + fileTypeFound = true; + } + + if (ccEmailAddresses.getClass().equals(java.io.File.class) + || ccEmailAddresses.getClass().equals(Integer.class) + || ccEmailAddresses.getClass().equals(String.class) + || ccEmailAddresses.getClass().isEnum()) { + map.put("cc_email_addresses", ccEmailAddresses); + } else if (isListOfFile(ccEmailAddresses)) { + for (int i = 0; i < getListSize(ccEmailAddresses); i++) { + map.put("cc_email_addresses[" + i + "]", getFromList(ccEmailAddresses, i)); + } + } else { + map.put( + "cc_email_addresses", + JSON.getDefault().getMapper().writeValueAsString(ccEmailAddresses)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) + || clientId.getClass().equals(Integer.class) + || clientId.getClass().equals(String.class) + || clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for (int i = 0; i < getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } else { + map.put( + "client_id", + JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) + || customFields.getClass().equals(Integer.class) + || customFields.getClass().equals(String.class) + || customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for (int i = 0; i < getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } else { + map.put( + "custom_fields", + JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (fieldOptions != null) { + if (isFileTypeOrListOfFiles(fieldOptions)) { + fileTypeFound = true; + } + + if (fieldOptions.getClass().equals(java.io.File.class) + || fieldOptions.getClass().equals(Integer.class) + || fieldOptions.getClass().equals(String.class) + || fieldOptions.getClass().isEnum()) { + map.put("field_options", fieldOptions); + } else if (isListOfFile(fieldOptions)) { + for (int i = 0; i < getListSize(fieldOptions); i++) { + map.put("field_options[" + i + "]", getFromList(fieldOptions, i)); + } + } else { + map.put( + "field_options", + JSON.getDefault().getMapper().writeValueAsString(fieldOptions)); + } + } + if (formFieldGroups != null) { + if (isFileTypeOrListOfFiles(formFieldGroups)) { + fileTypeFound = true; + } + + if (formFieldGroups.getClass().equals(java.io.File.class) + || formFieldGroups.getClass().equals(Integer.class) + || formFieldGroups.getClass().equals(String.class) + || formFieldGroups.getClass().isEnum()) { + map.put("form_field_groups", formFieldGroups); + } else if (isListOfFile(formFieldGroups)) { + for (int i = 0; i < getListSize(formFieldGroups); i++) { + map.put("form_field_groups[" + i + "]", getFromList(formFieldGroups, i)); + } + } else { + map.put( + "form_field_groups", + JSON.getDefault().getMapper().writeValueAsString(formFieldGroups)); + } + } + if (formFieldRules != null) { + if (isFileTypeOrListOfFiles(formFieldRules)) { + fileTypeFound = true; + } + + if (formFieldRules.getClass().equals(java.io.File.class) + || formFieldRules.getClass().equals(Integer.class) + || formFieldRules.getClass().equals(String.class) + || formFieldRules.getClass().isEnum()) { + map.put("form_field_rules", formFieldRules); + } else if (isListOfFile(formFieldRules)) { + for (int i = 0; i < getListSize(formFieldRules); i++) { + map.put("form_field_rules[" + i + "]", getFromList(formFieldRules, i)); + } + } else { + map.put( + "form_field_rules", + JSON.getDefault().getMapper().writeValueAsString(formFieldRules)); + } + } + if (formFieldsPerDocument != null) { + if (isFileTypeOrListOfFiles(formFieldsPerDocument)) { + fileTypeFound = true; + } + + if (formFieldsPerDocument.getClass().equals(java.io.File.class) + || formFieldsPerDocument.getClass().equals(Integer.class) + || formFieldsPerDocument.getClass().equals(String.class) + || formFieldsPerDocument.getClass().isEnum()) { + map.put("form_fields_per_document", formFieldsPerDocument); + } else if (isListOfFile(formFieldsPerDocument)) { + for (int i = 0; i < getListSize(formFieldsPerDocument); i++) { + map.put( + "form_fields_per_document[" + i + "]", + getFromList(formFieldsPerDocument, i)); + } + } else { + map.put( + "form_fields_per_document", + JSON.getDefault() + .getMapper() + .writeValueAsString(formFieldsPerDocument)); + } + } + if (hideTextTags != null) { + if (isFileTypeOrListOfFiles(hideTextTags)) { + fileTypeFound = true; + } + + if (hideTextTags.getClass().equals(java.io.File.class) + || hideTextTags.getClass().equals(Integer.class) + || hideTextTags.getClass().equals(String.class) + || hideTextTags.getClass().isEnum()) { + map.put("hide_text_tags", hideTextTags); + } else if (isListOfFile(hideTextTags)) { + for (int i = 0; i < getListSize(hideTextTags); i++) { + map.put("hide_text_tags[" + i + "]", getFromList(hideTextTags, i)); + } + } else { + map.put( + "hide_text_tags", + JSON.getDefault().getMapper().writeValueAsString(hideTextTags)); + } + } + if (isEid != null) { + if (isFileTypeOrListOfFiles(isEid)) { + fileTypeFound = true; + } + + if (isEid.getClass().equals(java.io.File.class) + || isEid.getClass().equals(Integer.class) + || isEid.getClass().equals(String.class) + || isEid.getClass().isEnum()) { + map.put("is_eid", isEid); + } else if (isListOfFile(isEid)) { + for (int i = 0; i < getListSize(isEid); i++) { + map.put("is_eid[" + i + "]", getFromList(isEid, i)); + } + } else { + map.put("is_eid", JSON.getDefault().getMapper().writeValueAsString(isEid)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) + || message.getClass().equals(Integer.class) + || message.getClass().equals(String.class) + || message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for (int i = 0; i < getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) + || metadata.getClass().equals(Integer.class) + || metadata.getClass().equals(String.class) + || metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for (int i = 0; i < getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) + || signingOptions.getClass().equals(Integer.class) + || signingOptions.getClass().equals(String.class) + || signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for (int i = 0; i < getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } else { + map.put( + "signing_options", + JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (signingRedirectUrl != null) { + if (isFileTypeOrListOfFiles(signingRedirectUrl)) { + fileTypeFound = true; + } + + if (signingRedirectUrl.getClass().equals(java.io.File.class) + || signingRedirectUrl.getClass().equals(Integer.class) + || signingRedirectUrl.getClass().equals(String.class) + || signingRedirectUrl.getClass().isEnum()) { + map.put("signing_redirect_url", signingRedirectUrl); + } else if (isListOfFile(signingRedirectUrl)) { + for (int i = 0; i < getListSize(signingRedirectUrl); i++) { + map.put( + "signing_redirect_url[" + i + "]", + getFromList(signingRedirectUrl, i)); + } + } else { + map.put( + "signing_redirect_url", + JSON.getDefault().getMapper().writeValueAsString(signingRedirectUrl)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) + || subject.getClass().equals(Integer.class) + || subject.getClass().equals(String.class) + || subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for (int i = 0; i < getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) + || testMode.getClass().equals(Integer.class) + || testMode.getClass().equals(String.class) + || testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for (int i = 0; i < getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } else { + map.put( + "test_mode", + JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) + || title.getClass().equals(Integer.class) + || title.getClass().equals(String.class) + || title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for (int i = 0; i < getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (useTextTags != null) { + if (isFileTypeOrListOfFiles(useTextTags)) { + fileTypeFound = true; + } + + if (useTextTags.getClass().equals(java.io.File.class) + || useTextTags.getClass().equals(Integer.class) + || useTextTags.getClass().equals(String.class) + || useTextTags.getClass().isEnum()) { + map.put("use_text_tags", useTextTags); + } else if (isListOfFile(useTextTags)) { + for (int i = 0; i < getListSize(useTextTags); i++) { + map.put("use_text_tags[" + i + "]", getFromList(useTextTags, i)); + } + } else { + map.put( + "use_text_tags", + JSON.getDefault().getMapper().writeValueAsString(useTextTags)); + } + } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) + || expiresAt.getClass().equals(Integer.class) + || expiresAt.getClass().equals(String.class) + || expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for (int i = 0; i < getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } else { + map.put( + "expires_at", + JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java new file mode 100644 index 000000000..3621d0d2f --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -0,0 +1,983 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** */ +@JsonPropertyOrder({ + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEMPLATE_IDS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CCS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_FILES, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_IS_EID, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class SignatureRequestEditWithTemplateRequest { + public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + private List templateIds = new ArrayList<>(); + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = new ArrayList<>(); + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_CCS = "ccs"; + private List ccs = null; + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_IS_EID = "is_eid"; + private Boolean isEid = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + private String signingRedirectUrl; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public SignatureRequestEditWithTemplateRequest() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static SignatureRequestEditWithTemplateRequest init(String jsonData) throws Exception { + return new ObjectMapper() + .readValue(jsonData, SignatureRequestEditWithTemplateRequest.class); + } + + public static SignatureRequestEditWithTemplateRequest init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditWithTemplateRequest.class); + } + + public SignatureRequestEditWithTemplateRequest templateIds(List templateIds) { + this.templateIds = templateIds; + return this; + } + + public SignatureRequestEditWithTemplateRequest addTemplateIdsItem(String templateIdsItem) { + if (this.templateIds == null) { + this.templateIds = new ArrayList<>(); + } + this.templateIds.add(templateIdsItem); + return this; + } + + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the + * order in which the template will be used. + * + * @return templateIds + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getTemplateIds() { + return templateIds; + } + + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateIds(List templateIds) { + this.templateIds = templateIds; + } + + public SignatureRequestEditWithTemplateRequest signers( + List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditWithTemplateRequest addSignersItem( + SubSignatureRequestTemplateSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Templated-based Signature Request. + * + * @return signers + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getSigners() { + return signers; + } + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSigners(List signers) { + this.signers = signers; + } + + public SignatureRequestEditWithTemplateRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to + * `false`. + * + * @return allowDecline + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowDecline() { + return allowDecline; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + public SignatureRequestEditWithTemplateRequest ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public SignatureRequestEditWithTemplateRequest addCcsItem(SubCC ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList<>(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * Add CC email recipients. Required when a CC role exists for the Template. + * + * @return ccs + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCcs() { + return ccs; + } + + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcs(List ccs) { + this.ccs = ccs; + } + + public SignatureRequestEditWithTemplateRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app to associate with the signature request. Used to apply the branding and + * callback url defined for the app. + * + * @return clientId + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getClientId() { + return clientId; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public SignatureRequestEditWithTemplateRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditWithTemplateRequest addCustomFieldsItem( + SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * An array defining values and options for custom fields. Required when a custom field exists + * in the Template. + * + * @return customFields + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getCustomFields() { + return customFields; + } + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + public SignatureRequestEditWithTemplateRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditWithTemplateRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint + * requires either **files** or **file_urls[]**, but not both. + * + * @return files + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFiles() { + return files; + } + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + public SignatureRequestEditWithTemplateRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditWithTemplateRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + * This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return fileUrls + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFileUrls() { + return fileUrls; + } + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + public SignatureRequestEditWithTemplateRequest isEid(Boolean isEid) { + this.isEid = isEid; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [electronic identification + * (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify + * their identity with an eID provider to sign a document.<br> **NOTE:** eID is only + * available on the Premium API plan. Cannot be used in `test_mode`. Only works on + * requests with one signer. + * + * @return isEid + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIsEid() { + return isEid; + } + + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEid(Boolean isEid) { + this.isEid = isEid; + } + + public SignatureRequestEditWithTemplateRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * + * @return message + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getMessage() { + return message; + } + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + public SignatureRequestEditWithTemplateRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditWithTemplateRequest putMetadataItem( + String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in + * all API responses and events involving the signature request. For example, use the metadata + * field to store a signer's order number for look up when receiving events for the + * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata + * keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return metadata + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public Map getMetadata() { + return metadata; + } + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + public SignatureRequestEditWithTemplateRequest signingOptions( + SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * + * @return signingOptions + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + public SignatureRequestEditWithTemplateRequest signingRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + return this; + } + + /** + * The URL you want signers redirected to after they successfully sign. + * + * @return signingRedirectUrl + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSigningRedirectUrl() { + return signingRedirectUrl; + } + + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + } + + public SignatureRequestEditWithTemplateRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * + * @return subject + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSubject() { + return subject; + } + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + public SignatureRequestEditWithTemplateRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to + * `true`. Defaults to `false`. + * + * @return testMode + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getTestMode() { + return testMode; + } + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + public SignatureRequestEditWithTemplateRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * + * @return title + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getTitle() { + return title; + } + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + /** Return true if this SignatureRequestEditWithTemplateRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest = + (SignatureRequestEditWithTemplateRequest) o; + return Objects.equals(this.templateIds, signatureRequestEditWithTemplateRequest.templateIds) + && Objects.equals(this.signers, signatureRequestEditWithTemplateRequest.signers) + && Objects.equals( + this.allowDecline, signatureRequestEditWithTemplateRequest.allowDecline) + && Objects.equals(this.ccs, signatureRequestEditWithTemplateRequest.ccs) + && Objects.equals(this.clientId, signatureRequestEditWithTemplateRequest.clientId) + && Objects.equals( + this.customFields, signatureRequestEditWithTemplateRequest.customFields) + && Objects.equals(this.files, signatureRequestEditWithTemplateRequest.files) + && Objects.equals(this.fileUrls, signatureRequestEditWithTemplateRequest.fileUrls) + && Objects.equals(this.isEid, signatureRequestEditWithTemplateRequest.isEid) + && Objects.equals(this.message, signatureRequestEditWithTemplateRequest.message) + && Objects.equals(this.metadata, signatureRequestEditWithTemplateRequest.metadata) + && Objects.equals( + this.signingOptions, signatureRequestEditWithTemplateRequest.signingOptions) + && Objects.equals( + this.signingRedirectUrl, + signatureRequestEditWithTemplateRequest.signingRedirectUrl) + && Objects.equals(this.subject, signatureRequestEditWithTemplateRequest.subject) + && Objects.equals(this.testMode, signatureRequestEditWithTemplateRequest.testMode) + && Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title); + } + + @Override + public int hashCode() { + return Objects.hash( + templateIds, + signers, + allowDecline, + ccs, + clientId, + customFields, + files, + fileUrls, + isEid, + message, + metadata, + signingOptions, + signingRedirectUrl, + subject, + testMode, + title); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditWithTemplateRequest {\n"); + sb.append(" templateIds: ").append(toIndentedString(templateIds)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" isEid: ").append(toIndentedString(isEid)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" signingRedirectUrl: ") + .append(toIndentedString(signingRedirectUrl)) + .append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (templateIds != null) { + if (isFileTypeOrListOfFiles(templateIds)) { + fileTypeFound = true; + } + + if (templateIds.getClass().equals(java.io.File.class) + || templateIds.getClass().equals(Integer.class) + || templateIds.getClass().equals(String.class) + || templateIds.getClass().isEnum()) { + map.put("template_ids", templateIds); + } else if (isListOfFile(templateIds)) { + for (int i = 0; i < getListSize(templateIds); i++) { + map.put("template_ids[" + i + "]", getFromList(templateIds, i)); + } + } else { + map.put( + "template_ids", + JSON.getDefault().getMapper().writeValueAsString(templateIds)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) + || signers.getClass().equals(Integer.class) + || signers.getClass().equals(String.class) + || signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for (int i = 0; i < getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) + || allowDecline.getClass().equals(Integer.class) + || allowDecline.getClass().equals(String.class) + || allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for (int i = 0; i < getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } else { + map.put( + "allow_decline", + JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (ccs != null) { + if (isFileTypeOrListOfFiles(ccs)) { + fileTypeFound = true; + } + + if (ccs.getClass().equals(java.io.File.class) + || ccs.getClass().equals(Integer.class) + || ccs.getClass().equals(String.class) + || ccs.getClass().isEnum()) { + map.put("ccs", ccs); + } else if (isListOfFile(ccs)) { + for (int i = 0; i < getListSize(ccs); i++) { + map.put("ccs[" + i + "]", getFromList(ccs, i)); + } + } else { + map.put("ccs", JSON.getDefault().getMapper().writeValueAsString(ccs)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) + || clientId.getClass().equals(Integer.class) + || clientId.getClass().equals(String.class) + || clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for (int i = 0; i < getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } else { + map.put( + "client_id", + JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) + || customFields.getClass().equals(Integer.class) + || customFields.getClass().equals(String.class) + || customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for (int i = 0; i < getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } else { + map.put( + "custom_fields", + JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) + || files.getClass().equals(Integer.class) + || files.getClass().equals(String.class) + || files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for (int i = 0; i < getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) + || fileUrls.getClass().equals(Integer.class) + || fileUrls.getClass().equals(String.class) + || fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for (int i = 0; i < getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } else { + map.put( + "file_urls", + JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (isEid != null) { + if (isFileTypeOrListOfFiles(isEid)) { + fileTypeFound = true; + } + + if (isEid.getClass().equals(java.io.File.class) + || isEid.getClass().equals(Integer.class) + || isEid.getClass().equals(String.class) + || isEid.getClass().isEnum()) { + map.put("is_eid", isEid); + } else if (isListOfFile(isEid)) { + for (int i = 0; i < getListSize(isEid); i++) { + map.put("is_eid[" + i + "]", getFromList(isEid, i)); + } + } else { + map.put("is_eid", JSON.getDefault().getMapper().writeValueAsString(isEid)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) + || message.getClass().equals(Integer.class) + || message.getClass().equals(String.class) + || message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for (int i = 0; i < getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) + || metadata.getClass().equals(Integer.class) + || metadata.getClass().equals(String.class) + || metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for (int i = 0; i < getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) + || signingOptions.getClass().equals(Integer.class) + || signingOptions.getClass().equals(String.class) + || signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for (int i = 0; i < getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } else { + map.put( + "signing_options", + JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (signingRedirectUrl != null) { + if (isFileTypeOrListOfFiles(signingRedirectUrl)) { + fileTypeFound = true; + } + + if (signingRedirectUrl.getClass().equals(java.io.File.class) + || signingRedirectUrl.getClass().equals(Integer.class) + || signingRedirectUrl.getClass().equals(String.class) + || signingRedirectUrl.getClass().isEnum()) { + map.put("signing_redirect_url", signingRedirectUrl); + } else if (isListOfFile(signingRedirectUrl)) { + for (int i = 0; i < getListSize(signingRedirectUrl); i++) { + map.put( + "signing_redirect_url[" + i + "]", + getFromList(signingRedirectUrl, i)); + } + } else { + map.put( + "signing_redirect_url", + JSON.getDefault().getMapper().writeValueAsString(signingRedirectUrl)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) + || subject.getClass().equals(Integer.class) + || subject.getClass().equals(String.class) + || subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for (int i = 0; i < getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) + || testMode.getClass().equals(Integer.class) + || testMode.getClass().equals(String.class) + || testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for (int i = 0; i < getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } else { + map.put( + "test_mode", + JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) + || title.getClass().equals(Integer.class) + || title.getClass().equals(String.class) + || title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for (int i = 0; i < getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index c012f8fdb..af3ac5223 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -173,6 +173,10 @@ Class | Method | HTTP request | Description *SignatureRequestApi* | [**signatureRequestCancel**](docs/SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](docs/SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +*SignatureRequestApi* | [**signatureRequestEdit**](docs/SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +*SignatureRequestApi* | [**signatureRequestEditEmbedded**](docs/SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +*SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +*SignatureRequestApi* | [**signatureRequestEditWithTemplate**](docs/SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template *SignatureRequestApi* | [**signatureRequestFiles**](docs/SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](docs/SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](docs/SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -276,6 +280,10 @@ Class | Method | HTTP request | Description - [SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) diff --git a/sdks/java-v2/docs/SignatureRequestApi.md b/sdks/java-v2/docs/SignatureRequestApi.md index 60e02426f..4a9a22b75 100644 --- a/sdks/java-v2/docs/SignatureRequestApi.md +++ b/sdks/java-v2/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3* [**signatureRequestCancel**](SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request [**signatureRequestCreateEmbedded**](SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request [**signatureRequestCreateEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +[**signatureRequestEdit**](SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +[**signatureRequestEditEmbedded**](SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +[**signatureRequestEditEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +[**signatureRequestEditWithTemplate**](SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template [**signatureRequestFiles**](SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files [**signatureRequestFilesAsDataUri**](SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri [**signatureRequestFilesAsFileUrl**](SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -532,6 +536,442 @@ public class Example { | **4XX** | failed_operation | - | +## signatureRequestEdit + +> SignatureRequestGetResponse signatureRequestEdit(signatureRequestId, signatureRequestEditRequest) + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + +**NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.util.List; +import java.util.Map; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestSigner() + .emailAddress("jack@example.com") + .name("Jack") + .order(0); + + var signer2 = new SubSignatureRequestSigner() + .emailAddress("jill@example.com") + .name("Jill") + .order(1); + + var signingOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(true) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var subFieldOptions = new SubFieldOptions() + .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditRequest() + .title("NDA with Acme Co.") + .subject("The NDA we talked about") + .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + .signers(List.of(signer1, signer2)) + .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) + .addFilesItem(new File("example_signature_request.pdf")) + .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) + .signingOptions(signingOptions) + .fieldOptions(subFieldOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditRequest** | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + +## signatureRequestEditEmbedded + +> SignatureRequestGetResponse signatureRequestEditEmbedded(signatureRequestId, signatureRequestEditEmbeddedRequest) + +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestSigner() + .emailAddress("jack@example.com") + .name("Jack") + .order(0); + + var signer2 = new SubSignatureRequestSigner() + .emailAddress("jill@example.com") + .name("Jill") + .order(1); + + var signingOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(true) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditEmbeddedRequest() + .clientId("ec64a202072370a737edf4a0eb7f4437") + .title("NDA with Acme Co.") + .subject("The NDA we talked about") + .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + .signers(List.of(signer1, signer2)) + .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) + .addFilesItem(new File("example_signature_request.pdf")) + .signingOptions(signingOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( + signatureRequestId, + data + ); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditEmbeddedRequest** | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + +## signatureRequestEditEmbeddedWithTemplate + +> SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest) + +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestTemplateSigner() + .role("Client") + .name("George"); + + var subSigningOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(false) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditEmbeddedWithTemplateRequest() + .clientId("ec64a202072370a737edf4a0eb7f4437") + .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) + .subject("Purchase Order") + .message("Glad we could come to an agreement.") + .signers(List.of(signer1)) + .signingOptions(subSigningOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( + signatureRequestId, + data + ); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditEmbeddedWithTemplateRequest** | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + +## signatureRequestEditWithTemplate + +> SignatureRequestGetResponse signatureRequestEditWithTemplate(signatureRequestId, signatureRequestEditWithTemplateRequest) + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. + +**NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + // or, configure Bearer (JWT) authorization: oauth2 + /* + var apiClient = Configuration.getDefaultApiClient() + .setBearerToken("YOUR_ACCESS_TOKEN"); + */ + + var signatureRequestApi = new SignatureRequestApi(apiClient); + + var signer1 = new SubSignatureRequestTemplateSigner() + .role("Client") + .emailAddress("george@example.com") + .name("George"); + + var cc1 = new SubCC() + .role("Accounting") + .emailAddress("accouting@emaple.com"); + + var customField1 = new SubCustomField() + .name("Cost") + .value("$20,000") + .editor("Client") + .required(true); + + var signingOptions = new SubSigningOptions() + .draw(true) + .type(true) + .upload(true) + .phone(false) + .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + + var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + var data = new SignatureRequestEditWithTemplateRequest() + .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) + .subject("Purchase Order") + .message("Glad we could come to an agreement.") + .signers(List.of(signer1)) + .ccs(List.of(cc1)) + .customFields(List.of(customField1)) + .signingOptions(signingOptions) + .testMode(true); + + try { + SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( + signatureRequestId, + data + ); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditWithTemplateRequest** | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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 | - | + + ## signatureRequestFiles > File signatureRequestFiles(signatureRequestId, fileType) diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..dd8b06061 --- /dev/null +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,37 @@ + + +# SignatureRequestEditEmbeddedRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | +| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | +| `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```List```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + + + diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..3cc3dee72 --- /dev/null +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,28 @@ + + +# SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | + + + diff --git a/sdks/java-v2/docs/SignatureRequestEditRequest.md b/sdks/java-v2/docs/SignatureRequestEditRequest.md new file mode 100644 index 000000000..7fa3aca65 --- /dev/null +++ b/sdks/java-v2/docs/SignatureRequestEditRequest.md @@ -0,0 +1,38 @@ + + +# SignatureRequestEditRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | +| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | +| `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```List```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | +| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + + + diff --git a/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..d079524b1 --- /dev/null +++ b/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,29 @@ + + +# SignatureRequestEditWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | + + + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java index 711191bc9..93510972e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java @@ -17,6 +17,10 @@ import com.dropbox.sign.model.SignatureRequestBulkSendWithTemplateRequest; import com.dropbox.sign.model.SignatureRequestCreateEmbeddedRequest; import com.dropbox.sign.model.SignatureRequestCreateEmbeddedWithTemplateRequest; +import com.dropbox.sign.model.SignatureRequestEditEmbeddedRequest; +import com.dropbox.sign.model.SignatureRequestEditEmbeddedWithTemplateRequest; +import com.dropbox.sign.model.SignatureRequestEditRequest; +import com.dropbox.sign.model.SignatureRequestEditWithTemplateRequest; import com.dropbox.sign.model.SignatureRequestGetResponse; import com.dropbox.sign.model.SignatureRequestListResponse; import com.dropbox.sign.model.SignatureRequestRemindRequest; @@ -367,6 +371,286 @@ public ApiResponse signatureRequestCreateEmbeddedWi false ); } + /** + * Edit Signature Request. + * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEdit(String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) throws ApiException { + return signatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest).getData(); + } + + + /** + * Edit Signature Request. + * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditWithHttpInfo(String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEdit"); + } + if (signatureRequestEditRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditRequest' when calling signatureRequestEdit"); + } + + // Path parameters + String localVarPath = "/signature_request/edit/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEdit", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * Edit Embedded Signature Request. + * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEditEmbedded(String signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) throws ApiException { + return signatureRequestEditEmbeddedWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedRequest).getData(); + } + + + /** + * Edit Embedded Signature Request. + * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditEmbeddedWithHttpInfo(String signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditEmbedded"); + } + if (signatureRequestEditEmbeddedRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditEmbeddedRequest' when calling signatureRequestEditEmbedded"); + } + + // Path parameters + String localVarPath = "/signature_request/edit_embedded/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditEmbeddedRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEditEmbedded", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditEmbeddedRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * Edit Embedded Signature Request with Template. + * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedWithTemplateRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(String signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) throws ApiException { + return signatureRequestEditEmbeddedWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest).getData(); + } + + + /** + * Edit Embedded Signature Request with Template. + * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedWithTemplateRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditEmbeddedWithTemplateWithHttpInfo(String signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditEmbeddedWithTemplate"); + } + if (signatureRequestEditEmbeddedWithTemplateRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' when calling signatureRequestEditEmbeddedWithTemplate"); + } + + // Path parameters + String localVarPath = "/signature_request/edit_embedded_with_template/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditEmbeddedWithTemplateRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEditEmbeddedWithTemplate", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditEmbeddedWithTemplateRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * Edit Signature Request With Template. + * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditWithTemplateRequest (required) + * @return SignatureRequestGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEditWithTemplate(String signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) throws ApiException { + return signatureRequestEditWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditWithTemplateRequest).getData(); + } + + + /** + * Edit Signature Request With Template. + * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditWithTemplateRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse signatureRequestEditWithTemplateWithHttpInfo(String signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditWithTemplate"); + } + if (signatureRequestEditWithTemplateRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditWithTemplateRequest' when calling signatureRequestEditWithTemplate"); + } + + // Path parameters + String localVarPath = "/signature_request/edit_with_template/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditWithTemplateRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "SignatureRequestApi.signatureRequestEditWithTemplate", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditWithTemplateRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } /** * Download Files. * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java new file mode 100644 index 000000000..cc5c34cc5 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -0,0 +1,1430 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.SubAttachment; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubFieldOptions; +import com.dropbox.sign.model.SubFormFieldGroup; +import com.dropbox.sign.model.SubFormFieldRule; +import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; +import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; +import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSigningOptions; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * SignatureRequestEditEmbeddedRequest + */ +@JsonPropertyOrder({ + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FILES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FIELD_OPTIONS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELD_GROUPS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELD_RULES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_HIDE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditEmbeddedRequest { + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = null; + + public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + private List groupedSigners = null; + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + private Boolean allowReassign = false; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = null; + + public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + private List ccEmailAddresses = null; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + private SubFieldOptions fieldOptions; + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + private List formFieldGroups = null; + + public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + private List formFieldRules = null; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + private List formFieldsPerDocument = null; + + public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + private Boolean hideTextTags = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + private Boolean useTextTags = false; + + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + private Boolean populateAutoFillFields = false; + + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + private Integer expiresAt; + + public SignatureRequestEditEmbeddedRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditEmbeddedRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditEmbeddedRequest.class); + } + + static public SignatureRequestEditEmbeddedRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditEmbeddedRequest.class + ); + } + + public SignatureRequestEditEmbeddedRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app you're using to create this embedded signature request. Used for security purposes. + * @return clientId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditEmbeddedRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + + public SignatureRequestEditEmbeddedRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditEmbeddedRequest signers(List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditEmbeddedRequest addSignersItem(SubSignatureRequestSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return signers + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigners(List signers) { + this.signers = signers; + } + + + public SignatureRequestEditEmbeddedRequest groupedSigners(List groupedSigners) { + this.groupedSigners = groupedSigners; + return this; + } + + public SignatureRequestEditEmbeddedRequest addGroupedSignersItem(SubSignatureRequestGroupedSigners groupedSignersItem) { + if (this.groupedSigners == null) { + this.groupedSigners = new ArrayList<>(); + } + this.groupedSigners.add(groupedSignersItem); + return this; + } + + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return groupedSigners + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getGroupedSigners() { + return groupedSigners; + } + + + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroupedSigners(List groupedSigners) { + this.groupedSigners = groupedSigners; + } + + + public SignatureRequestEditEmbeddedRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditEmbeddedRequest allowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + return this; + } + + /** + * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + * @return allowReassign + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowReassign() { + return allowReassign; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + } + + + public SignatureRequestEditEmbeddedRequest attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public SignatureRequestEditEmbeddedRequest addAttachmentsItem(SubAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * A list describing the attachments + * @return attachments + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + + public SignatureRequestEditEmbeddedRequest ccEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + return this; + } + + public SignatureRequestEditEmbeddedRequest addCcEmailAddressesItem(String ccEmailAddressesItem) { + if (this.ccEmailAddresses == null) { + this.ccEmailAddresses = new ArrayList<>(); + } + this.ccEmailAddresses.add(ccEmailAddressesItem); + return this; + } + + /** + * The email addresses that should be CCed. + * @return ccEmailAddresses + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcEmailAddresses() { + return ccEmailAddresses; + } + + + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + } + + + public SignatureRequestEditEmbeddedRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditEmbeddedRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditEmbeddedRequest fieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + return this; + } + + /** + * Get fieldOptions + * @return fieldOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubFieldOptions getFieldOptions() { + return fieldOptions; + } + + + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + } + + + public SignatureRequestEditEmbeddedRequest formFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldGroupsItem(SubFormFieldGroup formFieldGroupsItem) { + if (this.formFieldGroups == null) { + this.formFieldGroups = new ArrayList<>(); + } + this.formFieldGroups.add(formFieldGroupsItem); + return this; + } + + /** + * Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @return formFieldGroups + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldGroups() { + return formFieldGroups; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + + public SignatureRequestEditEmbeddedRequest formFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldRulesItem(SubFormFieldRule formFieldRulesItem) { + if (this.formFieldRules == null) { + this.formFieldRules = new ArrayList<>(); + } + this.formFieldRules.add(formFieldRulesItem); + return this; + } + + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + * @return formFieldRules + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldRules() { + return formFieldRules; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + } + + + public SignatureRequestEditEmbeddedRequest formFieldsPerDocument(List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldsPerDocumentItem(SubFormFieldsPerDocumentBase formFieldsPerDocumentItem) { + if (this.formFieldsPerDocument == null) { + this.formFieldsPerDocument = new ArrayList<>(); + } + this.formFieldsPerDocument.add(formFieldsPerDocumentItem); + return this; + } + + /** + * The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @return formFieldsPerDocument + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldsPerDocument(List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + + public SignatureRequestEditEmbeddedRequest hideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + return this; + } + + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + * @return hideTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getHideTextTags() { + return hideTextTags; + } + + + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + } + + + public SignatureRequestEditEmbeddedRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + + public SignatureRequestEditEmbeddedRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditEmbeddedRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditEmbeddedRequest signingOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditEmbeddedRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + + public SignatureRequestEditEmbeddedRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditEmbeddedRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + + public SignatureRequestEditEmbeddedRequest useTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + * @return useTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getUseTextTags() { + return useTextTags; + } + + + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUseTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + } + + + public SignatureRequestEditEmbeddedRequest populateAutoFillFields(Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + return this; + } + + /** + * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + * @return populateAutoFillFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getPopulateAutoFillFields() { + return populateAutoFillFields; + } + + + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + } + + + public SignatureRequestEditEmbeddedRequest expiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * @return expiresAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getExpiresAt() { + return expiresAt; + } + + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + } + + + /** + * Return true if this SignatureRequestEditEmbeddedRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest = (SignatureRequestEditEmbeddedRequest) o; + return Objects.equals(this.clientId, signatureRequestEditEmbeddedRequest.clientId) && + Objects.equals(this.files, signatureRequestEditEmbeddedRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditEmbeddedRequest.fileUrls) && + Objects.equals(this.signers, signatureRequestEditEmbeddedRequest.signers) && + Objects.equals(this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) && + Objects.equals(this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) && + Objects.equals(this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) && + Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) && + Objects.equals(this.ccEmailAddresses, signatureRequestEditEmbeddedRequest.ccEmailAddresses) && + Objects.equals(this.customFields, signatureRequestEditEmbeddedRequest.customFields) && + Objects.equals(this.fieldOptions, signatureRequestEditEmbeddedRequest.fieldOptions) && + Objects.equals(this.formFieldGroups, signatureRequestEditEmbeddedRequest.formFieldGroups) && + Objects.equals(this.formFieldRules, signatureRequestEditEmbeddedRequest.formFieldRules) && + Objects.equals(this.formFieldsPerDocument, signatureRequestEditEmbeddedRequest.formFieldsPerDocument) && + Objects.equals(this.hideTextTags, signatureRequestEditEmbeddedRequest.hideTextTags) && + Objects.equals(this.message, signatureRequestEditEmbeddedRequest.message) && + Objects.equals(this.metadata, signatureRequestEditEmbeddedRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditEmbeddedRequest.signingOptions) && + Objects.equals(this.subject, signatureRequestEditEmbeddedRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditEmbeddedRequest.testMode) && + Objects.equals(this.title, signatureRequestEditEmbeddedRequest.title) && + Objects.equals(this.useTextTags, signatureRequestEditEmbeddedRequest.useTextTags) && + Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedRequest.populateAutoFillFields) && + Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt); + } + + @Override + public int hashCode() { + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditEmbeddedRequest {\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" fieldOptions: ").append(toIndentedString(fieldOptions)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" formFieldRules: ").append(toIndentedString(formFieldRules)).append("\n"); + sb.append(" formFieldsPerDocument: ").append(toIndentedString(formFieldsPerDocument)).append("\n"); + sb.append(" hideTextTags: ").append(toIndentedString(hideTextTags)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (groupedSigners != null) { + if (isFileTypeOrListOfFiles(groupedSigners)) { + fileTypeFound = true; + } + + if (groupedSigners.getClass().equals(java.io.File.class) || + groupedSigners.getClass().equals(Integer.class) || + groupedSigners.getClass().equals(String.class) || + groupedSigners.getClass().isEnum()) { + map.put("grouped_signers", groupedSigners); + } else if (isListOfFile(groupedSigners)) { + for(int i = 0; i< getListSize(groupedSigners); i++) { + map.put("grouped_signers[" + i + "]", getFromList(groupedSigners, i)); + } + } + else { + map.put("grouped_signers", JSON.getDefault().getMapper().writeValueAsString(groupedSigners)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (allowReassign != null) { + if (isFileTypeOrListOfFiles(allowReassign)) { + fileTypeFound = true; + } + + if (allowReassign.getClass().equals(java.io.File.class) || + allowReassign.getClass().equals(Integer.class) || + allowReassign.getClass().equals(String.class) || + allowReassign.getClass().isEnum()) { + map.put("allow_reassign", allowReassign); + } else if (isListOfFile(allowReassign)) { + for(int i = 0; i< getListSize(allowReassign); i++) { + map.put("allow_reassign[" + i + "]", getFromList(allowReassign, i)); + } + } + else { + map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (ccEmailAddresses != null) { + if (isFileTypeOrListOfFiles(ccEmailAddresses)) { + fileTypeFound = true; + } + + if (ccEmailAddresses.getClass().equals(java.io.File.class) || + ccEmailAddresses.getClass().equals(Integer.class) || + ccEmailAddresses.getClass().equals(String.class) || + ccEmailAddresses.getClass().isEnum()) { + map.put("cc_email_addresses", ccEmailAddresses); + } else if (isListOfFile(ccEmailAddresses)) { + for(int i = 0; i< getListSize(ccEmailAddresses); i++) { + map.put("cc_email_addresses[" + i + "]", getFromList(ccEmailAddresses, i)); + } + } + else { + map.put("cc_email_addresses", JSON.getDefault().getMapper().writeValueAsString(ccEmailAddresses)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (fieldOptions != null) { + if (isFileTypeOrListOfFiles(fieldOptions)) { + fileTypeFound = true; + } + + if (fieldOptions.getClass().equals(java.io.File.class) || + fieldOptions.getClass().equals(Integer.class) || + fieldOptions.getClass().equals(String.class) || + fieldOptions.getClass().isEnum()) { + map.put("field_options", fieldOptions); + } else if (isListOfFile(fieldOptions)) { + for(int i = 0; i< getListSize(fieldOptions); i++) { + map.put("field_options[" + i + "]", getFromList(fieldOptions, i)); + } + } + else { + map.put("field_options", JSON.getDefault().getMapper().writeValueAsString(fieldOptions)); + } + } + if (formFieldGroups != null) { + if (isFileTypeOrListOfFiles(formFieldGroups)) { + fileTypeFound = true; + } + + if (formFieldGroups.getClass().equals(java.io.File.class) || + formFieldGroups.getClass().equals(Integer.class) || + formFieldGroups.getClass().equals(String.class) || + formFieldGroups.getClass().isEnum()) { + map.put("form_field_groups", formFieldGroups); + } else if (isListOfFile(formFieldGroups)) { + for(int i = 0; i< getListSize(formFieldGroups); i++) { + map.put("form_field_groups[" + i + "]", getFromList(formFieldGroups, i)); + } + } + else { + map.put("form_field_groups", JSON.getDefault().getMapper().writeValueAsString(formFieldGroups)); + } + } + if (formFieldRules != null) { + if (isFileTypeOrListOfFiles(formFieldRules)) { + fileTypeFound = true; + } + + if (formFieldRules.getClass().equals(java.io.File.class) || + formFieldRules.getClass().equals(Integer.class) || + formFieldRules.getClass().equals(String.class) || + formFieldRules.getClass().isEnum()) { + map.put("form_field_rules", formFieldRules); + } else if (isListOfFile(formFieldRules)) { + for(int i = 0; i< getListSize(formFieldRules); i++) { + map.put("form_field_rules[" + i + "]", getFromList(formFieldRules, i)); + } + } + else { + map.put("form_field_rules", JSON.getDefault().getMapper().writeValueAsString(formFieldRules)); + } + } + if (formFieldsPerDocument != null) { + if (isFileTypeOrListOfFiles(formFieldsPerDocument)) { + fileTypeFound = true; + } + + if (formFieldsPerDocument.getClass().equals(java.io.File.class) || + formFieldsPerDocument.getClass().equals(Integer.class) || + formFieldsPerDocument.getClass().equals(String.class) || + formFieldsPerDocument.getClass().isEnum()) { + map.put("form_fields_per_document", formFieldsPerDocument); + } else if (isListOfFile(formFieldsPerDocument)) { + for(int i = 0; i< getListSize(formFieldsPerDocument); i++) { + map.put("form_fields_per_document[" + i + "]", getFromList(formFieldsPerDocument, i)); + } + } + else { + map.put("form_fields_per_document", JSON.getDefault().getMapper().writeValueAsString(formFieldsPerDocument)); + } + } + if (hideTextTags != null) { + if (isFileTypeOrListOfFiles(hideTextTags)) { + fileTypeFound = true; + } + + if (hideTextTags.getClass().equals(java.io.File.class) || + hideTextTags.getClass().equals(Integer.class) || + hideTextTags.getClass().equals(String.class) || + hideTextTags.getClass().isEnum()) { + map.put("hide_text_tags", hideTextTags); + } else if (isListOfFile(hideTextTags)) { + for(int i = 0; i< getListSize(hideTextTags); i++) { + map.put("hide_text_tags[" + i + "]", getFromList(hideTextTags, i)); + } + } + else { + map.put("hide_text_tags", JSON.getDefault().getMapper().writeValueAsString(hideTextTags)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) || + testMode.getClass().equals(Integer.class) || + testMode.getClass().equals(String.class) || + testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for(int i = 0; i< getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } + else { + map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (useTextTags != null) { + if (isFileTypeOrListOfFiles(useTextTags)) { + fileTypeFound = true; + } + + if (useTextTags.getClass().equals(java.io.File.class) || + useTextTags.getClass().equals(Integer.class) || + useTextTags.getClass().equals(String.class) || + useTextTags.getClass().isEnum()) { + map.put("use_text_tags", useTextTags); + } else if (isListOfFile(useTextTags)) { + for(int i = 0; i< getListSize(useTextTags); i++) { + map.put("use_text_tags[" + i + "]", getFromList(useTextTags, i)); + } + } + else { + map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); + } + } + if (populateAutoFillFields != null) { + if (isFileTypeOrListOfFiles(populateAutoFillFields)) { + fileTypeFound = true; + } + + if (populateAutoFillFields.getClass().equals(java.io.File.class) || + populateAutoFillFields.getClass().equals(Integer.class) || + populateAutoFillFields.getClass().equals(String.class) || + populateAutoFillFields.getClass().isEnum()) { + map.put("populate_auto_fill_fields", populateAutoFillFields); + } else if (isListOfFile(populateAutoFillFields)) { + for(int i = 0; i< getListSize(populateAutoFillFields); i++) { + map.put("populate_auto_fill_fields[" + i + "]", getFromList(populateAutoFillFields, i)); + } + } + else { + map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); + } + } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) || + expiresAt.getClass().equals(Integer.class) || + expiresAt.getClass().equals(String.class) || + expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for(int i = 0; i< getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } + else { + map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java new file mode 100644 index 000000000..00615239f --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -0,0 +1,943 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.SubCC; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSigningOptions; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * SignatureRequestEditEmbeddedWithTemplateRequest + */ +@JsonPropertyOrder({ + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEMPLATE_IDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CCS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_FILES, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditEmbeddedWithTemplateRequest { + public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + private List templateIds = new ArrayList<>(); + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = new ArrayList<>(); + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_CCS = "ccs"; + private List ccs = null; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + private Boolean populateAutoFillFields = false; + + public SignatureRequestEditEmbeddedWithTemplateRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditEmbeddedWithTemplateRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditEmbeddedWithTemplateRequest.class); + } + + static public SignatureRequestEditEmbeddedWithTemplateRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditEmbeddedWithTemplateRequest.class + ); + } + + public SignatureRequestEditEmbeddedWithTemplateRequest templateIds(List templateIds) { + this.templateIds = templateIds; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addTemplateIdsItem(String templateIdsItem) { + if (this.templateIds == null) { + this.templateIds = new ArrayList<>(); + } + this.templateIds.add(templateIdsItem); + return this; + } + + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @return templateIds + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getTemplateIds() { + return templateIds; + } + + + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateIds(List templateIds) { + this.templateIds = templateIds; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app you're using to create this embedded signature request. Used for security purposes. + * @return clientId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest signers(List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addSignersItem(SubSignatureRequestTemplateSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Templated-based Signature Request. + * @return signers + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSigners(List signers) { + this.signers = signers; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addCcsItem(SubCC ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList<>(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * Add CC email recipients. Required when a CC role exists for the Template. + * @return ccs + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcs() { + return ccs; + } + + + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcs(List ccs) { + this.ccs = ccs; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest signingOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest populateAutoFillFields(Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + return this; + } + + /** + * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + * @return populateAutoFillFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getPopulateAutoFillFields() { + return populateAutoFillFields; + } + + + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + } + + + /** + * Return true if this SignatureRequestEditEmbeddedWithTemplateRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest = (SignatureRequestEditEmbeddedWithTemplateRequest) o; + return Objects.equals(this.templateIds, signatureRequestEditEmbeddedWithTemplateRequest.templateIds) && + Objects.equals(this.clientId, signatureRequestEditEmbeddedWithTemplateRequest.clientId) && + Objects.equals(this.signers, signatureRequestEditEmbeddedWithTemplateRequest.signers) && + Objects.equals(this.allowDecline, signatureRequestEditEmbeddedWithTemplateRequest.allowDecline) && + Objects.equals(this.ccs, signatureRequestEditEmbeddedWithTemplateRequest.ccs) && + Objects.equals(this.customFields, signatureRequestEditEmbeddedWithTemplateRequest.customFields) && + Objects.equals(this.files, signatureRequestEditEmbeddedWithTemplateRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditEmbeddedWithTemplateRequest.fileUrls) && + Objects.equals(this.message, signatureRequestEditEmbeddedWithTemplateRequest.message) && + Objects.equals(this.metadata, signatureRequestEditEmbeddedWithTemplateRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditEmbeddedWithTemplateRequest.signingOptions) && + Objects.equals(this.subject, signatureRequestEditEmbeddedWithTemplateRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditEmbeddedWithTemplateRequest.testMode) && + Objects.equals(this.title, signatureRequestEditEmbeddedWithTemplateRequest.title) && + Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields); + } + + @Override + public int hashCode() { + return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditEmbeddedWithTemplateRequest {\n"); + sb.append(" templateIds: ").append(toIndentedString(templateIds)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (templateIds != null) { + if (isFileTypeOrListOfFiles(templateIds)) { + fileTypeFound = true; + } + + if (templateIds.getClass().equals(java.io.File.class) || + templateIds.getClass().equals(Integer.class) || + templateIds.getClass().equals(String.class) || + templateIds.getClass().isEnum()) { + map.put("template_ids", templateIds); + } else if (isListOfFile(templateIds)) { + for(int i = 0; i< getListSize(templateIds); i++) { + map.put("template_ids[" + i + "]", getFromList(templateIds, i)); + } + } + else { + map.put("template_ids", JSON.getDefault().getMapper().writeValueAsString(templateIds)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (ccs != null) { + if (isFileTypeOrListOfFiles(ccs)) { + fileTypeFound = true; + } + + if (ccs.getClass().equals(java.io.File.class) || + ccs.getClass().equals(Integer.class) || + ccs.getClass().equals(String.class) || + ccs.getClass().isEnum()) { + map.put("ccs", ccs); + } else if (isListOfFile(ccs)) { + for(int i = 0; i< getListSize(ccs); i++) { + map.put("ccs[" + i + "]", getFromList(ccs, i)); + } + } + else { + map.put("ccs", JSON.getDefault().getMapper().writeValueAsString(ccs)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) || + testMode.getClass().equals(Integer.class) || + testMode.getClass().equals(String.class) || + testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for(int i = 0; i< getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } + else { + map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (populateAutoFillFields != null) { + if (isFileTypeOrListOfFiles(populateAutoFillFields)) { + fileTypeFound = true; + } + + if (populateAutoFillFields.getClass().equals(java.io.File.class) || + populateAutoFillFields.getClass().equals(Integer.class) || + populateAutoFillFields.getClass().equals(String.class) || + populateAutoFillFields.getClass().isEnum()) { + map.put("populate_auto_fill_fields", populateAutoFillFields); + } else if (isListOfFile(populateAutoFillFields)) { + for(int i = 0; i< getListSize(populateAutoFillFields); i++) { + map.put("populate_auto_fill_fields[" + i + "]", getFromList(populateAutoFillFields, i)); + } + } + else { + map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java new file mode 100644 index 000000000..96dbcb67e --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -0,0 +1,1480 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.SubAttachment; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubFieldOptions; +import com.dropbox.sign.model.SubFormFieldGroup; +import com.dropbox.sign.model.SubFormFieldRule; +import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; +import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; +import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSigningOptions; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * SignatureRequestEditRequest + */ +@JsonPropertyOrder({ + SignatureRequestEditRequest.JSON_PROPERTY_FILES, + SignatureRequestEditRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, + SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, + SignatureRequestEditRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditRequest.JSON_PROPERTY_FIELD_OPTIONS, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELD_GROUPS, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELD_RULES, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + SignatureRequestEditRequest.JSON_PROPERTY_HIDE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_IS_EID, + SignatureRequestEditRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, + SignatureRequestEditRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditRequest { + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = null; + + public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + private List groupedSigners = null; + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + private Boolean allowReassign = false; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = null; + + public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + private List ccEmailAddresses = null; + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + private SubFieldOptions fieldOptions; + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + private List formFieldGroups = null; + + public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + private List formFieldRules = null; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + private List formFieldsPerDocument = null; + + public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + private Boolean hideTextTags = false; + + public static final String JSON_PROPERTY_IS_EID = "is_eid"; + private Boolean isEid = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + private String signingRedirectUrl; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + private Boolean useTextTags = false; + + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + private Integer expiresAt; + + public SignatureRequestEditRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditRequest.class); + } + + static public SignatureRequestEditRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditRequest.class + ); + } + + public SignatureRequestEditRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + + public SignatureRequestEditRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditRequest signers(List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditRequest addSignersItem(SubSignatureRequestSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return signers + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigners(List signers) { + this.signers = signers; + } + + + public SignatureRequestEditRequest groupedSigners(List groupedSigners) { + this.groupedSigners = groupedSigners; + return this; + } + + public SignatureRequestEditRequest addGroupedSignersItem(SubSignatureRequestGroupedSigners groupedSignersItem) { + if (this.groupedSigners == null) { + this.groupedSigners = new ArrayList<>(); + } + this.groupedSigners.add(groupedSignersItem); + return this; + } + + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return groupedSigners + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getGroupedSigners() { + return groupedSigners; + } + + + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroupedSigners(List groupedSigners) { + this.groupedSigners = groupedSigners; + } + + + public SignatureRequestEditRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditRequest allowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + return this; + } + + /** + * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + * @return allowReassign + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowReassign() { + return allowReassign; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowReassign(Boolean allowReassign) { + this.allowReassign = allowReassign; + } + + + public SignatureRequestEditRequest attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public SignatureRequestEditRequest addAttachmentsItem(SubAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * A list describing the attachments + * @return attachments + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + + public SignatureRequestEditRequest ccEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + return this; + } + + public SignatureRequestEditRequest addCcEmailAddressesItem(String ccEmailAddressesItem) { + if (this.ccEmailAddresses == null) { + this.ccEmailAddresses = new ArrayList<>(); + } + this.ccEmailAddresses.add(ccEmailAddressesItem); + return this; + } + + /** + * The email addresses that should be CCed. + * @return ccEmailAddresses + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcEmailAddresses() { + return ccEmailAddresses; + } + + + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcEmailAddresses(List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + } + + + public SignatureRequestEditRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + * @return clientId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditRequest fieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + return this; + } + + /** + * Get fieldOptions + * @return fieldOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubFieldOptions getFieldOptions() { + return fieldOptions; + } + + + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFieldOptions(SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + } + + + public SignatureRequestEditRequest formFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public SignatureRequestEditRequest addFormFieldGroupsItem(SubFormFieldGroup formFieldGroupsItem) { + if (this.formFieldGroups == null) { + this.formFieldGroups = new ArrayList<>(); + } + this.formFieldGroups.add(formFieldGroupsItem); + return this; + } + + /** + * Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * @return formFieldGroups + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldGroups() { + return formFieldGroups; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldGroups(List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + + public SignatureRequestEditRequest formFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + return this; + } + + public SignatureRequestEditRequest addFormFieldRulesItem(SubFormFieldRule formFieldRulesItem) { + if (this.formFieldRules == null) { + this.formFieldRules = new ArrayList<>(); + } + this.formFieldRules.add(formFieldRulesItem); + return this; + } + + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + * @return formFieldRules + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldRules() { + return formFieldRules; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldRules(List formFieldRules) { + this.formFieldRules = formFieldRules; + } + + + public SignatureRequestEditRequest formFieldsPerDocument(List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public SignatureRequestEditRequest addFormFieldsPerDocumentItem(SubFormFieldsPerDocumentBase formFieldsPerDocumentItem) { + if (this.formFieldsPerDocument == null) { + this.formFieldsPerDocument = new ArrayList<>(); + } + this.formFieldsPerDocument.add(formFieldsPerDocumentItem); + return this; + } + + /** + * The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @return formFieldsPerDocument + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldsPerDocument(List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + + public SignatureRequestEditRequest hideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + return this; + } + + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + * @return hideTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getHideTextTags() { + return hideTextTags; + } + + + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHideTextTags(Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + } + + + public SignatureRequestEditRequest isEid(Boolean isEid) { + this.isEid = isEid; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + * @return isEid + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEid() { + return isEid; + } + + + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEid(Boolean isEid) { + this.isEid = isEid; + } + + + public SignatureRequestEditRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + + public SignatureRequestEditRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditRequest signingOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditRequest signingRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + return this; + } + + /** + * The URL you want signers redirected to after they successfully sign. + * @return signingRedirectUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSigningRedirectUrl() { + return signingRedirectUrl; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + } + + + public SignatureRequestEditRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + + public SignatureRequestEditRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + + public SignatureRequestEditRequest useTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + * @return useTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getUseTextTags() { + return useTextTags; + } + + + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUseTextTags(Boolean useTextTags) { + this.useTextTags = useTextTags; + } + + + public SignatureRequestEditRequest expiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * @return expiresAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getExpiresAt() { + return expiresAt; + } + + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(Integer expiresAt) { + this.expiresAt = expiresAt; + } + + + /** + * Return true if this SignatureRequestEditRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditRequest signatureRequestEditRequest = (SignatureRequestEditRequest) o; + return Objects.equals(this.files, signatureRequestEditRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditRequest.fileUrls) && + Objects.equals(this.signers, signatureRequestEditRequest.signers) && + Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) && + Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) && + Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) && + Objects.equals(this.attachments, signatureRequestEditRequest.attachments) && + Objects.equals(this.ccEmailAddresses, signatureRequestEditRequest.ccEmailAddresses) && + Objects.equals(this.clientId, signatureRequestEditRequest.clientId) && + Objects.equals(this.customFields, signatureRequestEditRequest.customFields) && + Objects.equals(this.fieldOptions, signatureRequestEditRequest.fieldOptions) && + Objects.equals(this.formFieldGroups, signatureRequestEditRequest.formFieldGroups) && + Objects.equals(this.formFieldRules, signatureRequestEditRequest.formFieldRules) && + Objects.equals(this.formFieldsPerDocument, signatureRequestEditRequest.formFieldsPerDocument) && + Objects.equals(this.hideTextTags, signatureRequestEditRequest.hideTextTags) && + Objects.equals(this.isEid, signatureRequestEditRequest.isEid) && + Objects.equals(this.message, signatureRequestEditRequest.message) && + Objects.equals(this.metadata, signatureRequestEditRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditRequest.signingOptions) && + Objects.equals(this.signingRedirectUrl, signatureRequestEditRequest.signingRedirectUrl) && + Objects.equals(this.subject, signatureRequestEditRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditRequest.testMode) && + Objects.equals(this.title, signatureRequestEditRequest.title) && + Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) && + Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); + } + + @Override + public int hashCode() { + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditRequest {\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" fieldOptions: ").append(toIndentedString(fieldOptions)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" formFieldRules: ").append(toIndentedString(formFieldRules)).append("\n"); + sb.append(" formFieldsPerDocument: ").append(toIndentedString(formFieldsPerDocument)).append("\n"); + sb.append(" hideTextTags: ").append(toIndentedString(hideTextTags)).append("\n"); + sb.append(" isEid: ").append(toIndentedString(isEid)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" signingRedirectUrl: ").append(toIndentedString(signingRedirectUrl)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (groupedSigners != null) { + if (isFileTypeOrListOfFiles(groupedSigners)) { + fileTypeFound = true; + } + + if (groupedSigners.getClass().equals(java.io.File.class) || + groupedSigners.getClass().equals(Integer.class) || + groupedSigners.getClass().equals(String.class) || + groupedSigners.getClass().isEnum()) { + map.put("grouped_signers", groupedSigners); + } else if (isListOfFile(groupedSigners)) { + for(int i = 0; i< getListSize(groupedSigners); i++) { + map.put("grouped_signers[" + i + "]", getFromList(groupedSigners, i)); + } + } + else { + map.put("grouped_signers", JSON.getDefault().getMapper().writeValueAsString(groupedSigners)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (allowReassign != null) { + if (isFileTypeOrListOfFiles(allowReassign)) { + fileTypeFound = true; + } + + if (allowReassign.getClass().equals(java.io.File.class) || + allowReassign.getClass().equals(Integer.class) || + allowReassign.getClass().equals(String.class) || + allowReassign.getClass().isEnum()) { + map.put("allow_reassign", allowReassign); + } else if (isListOfFile(allowReassign)) { + for(int i = 0; i< getListSize(allowReassign); i++) { + map.put("allow_reassign[" + i + "]", getFromList(allowReassign, i)); + } + } + else { + map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (ccEmailAddresses != null) { + if (isFileTypeOrListOfFiles(ccEmailAddresses)) { + fileTypeFound = true; + } + + if (ccEmailAddresses.getClass().equals(java.io.File.class) || + ccEmailAddresses.getClass().equals(Integer.class) || + ccEmailAddresses.getClass().equals(String.class) || + ccEmailAddresses.getClass().isEnum()) { + map.put("cc_email_addresses", ccEmailAddresses); + } else if (isListOfFile(ccEmailAddresses)) { + for(int i = 0; i< getListSize(ccEmailAddresses); i++) { + map.put("cc_email_addresses[" + i + "]", getFromList(ccEmailAddresses, i)); + } + } + else { + map.put("cc_email_addresses", JSON.getDefault().getMapper().writeValueAsString(ccEmailAddresses)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (fieldOptions != null) { + if (isFileTypeOrListOfFiles(fieldOptions)) { + fileTypeFound = true; + } + + if (fieldOptions.getClass().equals(java.io.File.class) || + fieldOptions.getClass().equals(Integer.class) || + fieldOptions.getClass().equals(String.class) || + fieldOptions.getClass().isEnum()) { + map.put("field_options", fieldOptions); + } else if (isListOfFile(fieldOptions)) { + for(int i = 0; i< getListSize(fieldOptions); i++) { + map.put("field_options[" + i + "]", getFromList(fieldOptions, i)); + } + } + else { + map.put("field_options", JSON.getDefault().getMapper().writeValueAsString(fieldOptions)); + } + } + if (formFieldGroups != null) { + if (isFileTypeOrListOfFiles(formFieldGroups)) { + fileTypeFound = true; + } + + if (formFieldGroups.getClass().equals(java.io.File.class) || + formFieldGroups.getClass().equals(Integer.class) || + formFieldGroups.getClass().equals(String.class) || + formFieldGroups.getClass().isEnum()) { + map.put("form_field_groups", formFieldGroups); + } else if (isListOfFile(formFieldGroups)) { + for(int i = 0; i< getListSize(formFieldGroups); i++) { + map.put("form_field_groups[" + i + "]", getFromList(formFieldGroups, i)); + } + } + else { + map.put("form_field_groups", JSON.getDefault().getMapper().writeValueAsString(formFieldGroups)); + } + } + if (formFieldRules != null) { + if (isFileTypeOrListOfFiles(formFieldRules)) { + fileTypeFound = true; + } + + if (formFieldRules.getClass().equals(java.io.File.class) || + formFieldRules.getClass().equals(Integer.class) || + formFieldRules.getClass().equals(String.class) || + formFieldRules.getClass().isEnum()) { + map.put("form_field_rules", formFieldRules); + } else if (isListOfFile(formFieldRules)) { + for(int i = 0; i< getListSize(formFieldRules); i++) { + map.put("form_field_rules[" + i + "]", getFromList(formFieldRules, i)); + } + } + else { + map.put("form_field_rules", JSON.getDefault().getMapper().writeValueAsString(formFieldRules)); + } + } + if (formFieldsPerDocument != null) { + if (isFileTypeOrListOfFiles(formFieldsPerDocument)) { + fileTypeFound = true; + } + + if (formFieldsPerDocument.getClass().equals(java.io.File.class) || + formFieldsPerDocument.getClass().equals(Integer.class) || + formFieldsPerDocument.getClass().equals(String.class) || + formFieldsPerDocument.getClass().isEnum()) { + map.put("form_fields_per_document", formFieldsPerDocument); + } else if (isListOfFile(formFieldsPerDocument)) { + for(int i = 0; i< getListSize(formFieldsPerDocument); i++) { + map.put("form_fields_per_document[" + i + "]", getFromList(formFieldsPerDocument, i)); + } + } + else { + map.put("form_fields_per_document", JSON.getDefault().getMapper().writeValueAsString(formFieldsPerDocument)); + } + } + if (hideTextTags != null) { + if (isFileTypeOrListOfFiles(hideTextTags)) { + fileTypeFound = true; + } + + if (hideTextTags.getClass().equals(java.io.File.class) || + hideTextTags.getClass().equals(Integer.class) || + hideTextTags.getClass().equals(String.class) || + hideTextTags.getClass().isEnum()) { + map.put("hide_text_tags", hideTextTags); + } else if (isListOfFile(hideTextTags)) { + for(int i = 0; i< getListSize(hideTextTags); i++) { + map.put("hide_text_tags[" + i + "]", getFromList(hideTextTags, i)); + } + } + else { + map.put("hide_text_tags", JSON.getDefault().getMapper().writeValueAsString(hideTextTags)); + } + } + if (isEid != null) { + if (isFileTypeOrListOfFiles(isEid)) { + fileTypeFound = true; + } + + if (isEid.getClass().equals(java.io.File.class) || + isEid.getClass().equals(Integer.class) || + isEid.getClass().equals(String.class) || + isEid.getClass().isEnum()) { + map.put("is_eid", isEid); + } else if (isListOfFile(isEid)) { + for(int i = 0; i< getListSize(isEid); i++) { + map.put("is_eid[" + i + "]", getFromList(isEid, i)); + } + } + else { + map.put("is_eid", JSON.getDefault().getMapper().writeValueAsString(isEid)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (signingRedirectUrl != null) { + if (isFileTypeOrListOfFiles(signingRedirectUrl)) { + fileTypeFound = true; + } + + if (signingRedirectUrl.getClass().equals(java.io.File.class) || + signingRedirectUrl.getClass().equals(Integer.class) || + signingRedirectUrl.getClass().equals(String.class) || + signingRedirectUrl.getClass().isEnum()) { + map.put("signing_redirect_url", signingRedirectUrl); + } else if (isListOfFile(signingRedirectUrl)) { + for(int i = 0; i< getListSize(signingRedirectUrl); i++) { + map.put("signing_redirect_url[" + i + "]", getFromList(signingRedirectUrl, i)); + } + } + else { + map.put("signing_redirect_url", JSON.getDefault().getMapper().writeValueAsString(signingRedirectUrl)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) || + testMode.getClass().equals(Integer.class) || + testMode.getClass().equals(String.class) || + testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for(int i = 0; i< getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } + else { + map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (useTextTags != null) { + if (isFileTypeOrListOfFiles(useTextTags)) { + fileTypeFound = true; + } + + if (useTextTags.getClass().equals(java.io.File.class) || + useTextTags.getClass().equals(Integer.class) || + useTextTags.getClass().equals(String.class) || + useTextTags.getClass().isEnum()) { + map.put("use_text_tags", useTextTags); + } else if (isListOfFile(useTextTags)) { + for(int i = 0; i< getListSize(useTextTags); i++) { + map.put("use_text_tags[" + i + "]", getFromList(useTextTags, i)); + } + } + else { + map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); + } + } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) || + expiresAt.getClass().equals(Integer.class) || + expiresAt.getClass().equals(String.class) || + expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for(int i = 0; i< getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } + else { + map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java new file mode 100644 index 000000000..3eff53358 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -0,0 +1,993 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.SubCC; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSigningOptions; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * + */ +@JsonPropertyOrder({ + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEMPLATE_IDS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CCS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_FILES, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_IS_EID, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditWithTemplateRequest { + public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + private List templateIds = new ArrayList<>(); + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + private List signers = new ArrayList<>(); + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_CCS = "ccs"; + private List ccs = null; + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + private List customFields = null; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_IS_EID = "is_eid"; + private Boolean isEid = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + private String signingRedirectUrl; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public SignatureRequestEditWithTemplateRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditWithTemplateRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditWithTemplateRequest.class); + } + + static public SignatureRequestEditWithTemplateRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditWithTemplateRequest.class + ); + } + + public SignatureRequestEditWithTemplateRequest templateIds(List templateIds) { + this.templateIds = templateIds; + return this; + } + + public SignatureRequestEditWithTemplateRequest addTemplateIdsItem(String templateIdsItem) { + if (this.templateIds == null) { + this.templateIds = new ArrayList<>(); + } + this.templateIds.add(templateIdsItem); + return this; + } + + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @return templateIds + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getTemplateIds() { + return templateIds; + } + + + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateIds(List templateIds) { + this.templateIds = templateIds; + } + + + public SignatureRequestEditWithTemplateRequest signers(List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditWithTemplateRequest addSignersItem(SubSignatureRequestTemplateSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Templated-based Signature Request. + * @return signers + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSigners(List signers) { + this.signers = signers; + } + + + public SignatureRequestEditWithTemplateRequest allowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditWithTemplateRequest ccs(List ccs) { + this.ccs = ccs; + return this; + } + + public SignatureRequestEditWithTemplateRequest addCcsItem(SubCC ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList<>(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * Add CC email recipients. Required when a CC role exists for the Template. + * @return ccs + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcs() { + return ccs; + } + + + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcs(List ccs) { + this.ccs = ccs; + } + + + public SignatureRequestEditWithTemplateRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + * @return clientId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditWithTemplateRequest customFields(List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditWithTemplateRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditWithTemplateRequest files(List files) { + this.files = files; + return this; + } + + public SignatureRequestEditWithTemplateRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + + public SignatureRequestEditWithTemplateRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditWithTemplateRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditWithTemplateRequest isEid(Boolean isEid) { + this.isEid = isEid; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + * @return isEid + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEid() { + return isEid; + } + + + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEid(Boolean isEid) { + this.isEid = isEid; + } + + + public SignatureRequestEditWithTemplateRequest message(String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(String message) { + this.message = message; + } + + + public SignatureRequestEditWithTemplateRequest metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditWithTemplateRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditWithTemplateRequest signingOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditWithTemplateRequest signingRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + return this; + } + + /** + * The URL you want signers redirected to after they successfully sign. + * @return signingRedirectUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSigningRedirectUrl() { + return signingRedirectUrl; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningRedirectUrl(String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + } + + + public SignatureRequestEditWithTemplateRequest subject(String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(String subject) { + this.subject = subject; + } + + + public SignatureRequestEditWithTemplateRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditWithTemplateRequest title(String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + + /** + * Return true if this SignatureRequestEditWithTemplateRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest = (SignatureRequestEditWithTemplateRequest) o; + return Objects.equals(this.templateIds, signatureRequestEditWithTemplateRequest.templateIds) && + Objects.equals(this.signers, signatureRequestEditWithTemplateRequest.signers) && + Objects.equals(this.allowDecline, signatureRequestEditWithTemplateRequest.allowDecline) && + Objects.equals(this.ccs, signatureRequestEditWithTemplateRequest.ccs) && + Objects.equals(this.clientId, signatureRequestEditWithTemplateRequest.clientId) && + Objects.equals(this.customFields, signatureRequestEditWithTemplateRequest.customFields) && + Objects.equals(this.files, signatureRequestEditWithTemplateRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditWithTemplateRequest.fileUrls) && + Objects.equals(this.isEid, signatureRequestEditWithTemplateRequest.isEid) && + Objects.equals(this.message, signatureRequestEditWithTemplateRequest.message) && + Objects.equals(this.metadata, signatureRequestEditWithTemplateRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditWithTemplateRequest.signingOptions) && + Objects.equals(this.signingRedirectUrl, signatureRequestEditWithTemplateRequest.signingRedirectUrl) && + Objects.equals(this.subject, signatureRequestEditWithTemplateRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditWithTemplateRequest.testMode) && + Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title); + } + + @Override + public int hashCode() { + return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditWithTemplateRequest {\n"); + sb.append(" templateIds: ").append(toIndentedString(templateIds)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" isEid: ").append(toIndentedString(isEid)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" signingRedirectUrl: ").append(toIndentedString(signingRedirectUrl)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (templateIds != null) { + if (isFileTypeOrListOfFiles(templateIds)) { + fileTypeFound = true; + } + + if (templateIds.getClass().equals(java.io.File.class) || + templateIds.getClass().equals(Integer.class) || + templateIds.getClass().equals(String.class) || + templateIds.getClass().isEnum()) { + map.put("template_ids", templateIds); + } else if (isListOfFile(templateIds)) { + for(int i = 0; i< getListSize(templateIds); i++) { + map.put("template_ids[" + i + "]", getFromList(templateIds, i)); + } + } + else { + map.put("template_ids", JSON.getDefault().getMapper().writeValueAsString(templateIds)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (ccs != null) { + if (isFileTypeOrListOfFiles(ccs)) { + fileTypeFound = true; + } + + if (ccs.getClass().equals(java.io.File.class) || + ccs.getClass().equals(Integer.class) || + ccs.getClass().equals(String.class) || + ccs.getClass().isEnum()) { + map.put("ccs", ccs); + } else if (isListOfFile(ccs)) { + for(int i = 0; i< getListSize(ccs); i++) { + map.put("ccs[" + i + "]", getFromList(ccs, i)); + } + } + else { + map.put("ccs", JSON.getDefault().getMapper().writeValueAsString(ccs)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (isEid != null) { + if (isFileTypeOrListOfFiles(isEid)) { + fileTypeFound = true; + } + + if (isEid.getClass().equals(java.io.File.class) || + isEid.getClass().equals(Integer.class) || + isEid.getClass().equals(String.class) || + isEid.getClass().isEnum()) { + map.put("is_eid", isEid); + } else if (isListOfFile(isEid)) { + for(int i = 0; i< getListSize(isEid); i++) { + map.put("is_eid[" + i + "]", getFromList(isEid, i)); + } + } + else { + map.put("is_eid", JSON.getDefault().getMapper().writeValueAsString(isEid)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (signingRedirectUrl != null) { + if (isFileTypeOrListOfFiles(signingRedirectUrl)) { + fileTypeFound = true; + } + + if (signingRedirectUrl.getClass().equals(java.io.File.class) || + signingRedirectUrl.getClass().equals(Integer.class) || + signingRedirectUrl.getClass().equals(String.class) || + signingRedirectUrl.getClass().isEnum()) { + map.put("signing_redirect_url", signingRedirectUrl); + } else if (isListOfFile(signingRedirectUrl)) { + for(int i = 0; i< getListSize(signingRedirectUrl); i++) { + map.put("signing_redirect_url[" + i + "]", getFromList(signingRedirectUrl, i)); + } + } + else { + map.put("signing_redirect_url", JSON.getDefault().getMapper().writeValueAsString(signingRedirectUrl)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) || + testMode.getClass().equals(Integer.class) || + testMode.getClass().equals(String.class) || + testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for(int i = 0; i< getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } + else { + map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/node/README.md b/sdks/node/README.md index 7e05e443f..ea771b194 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -140,6 +140,10 @@ All URIs are relative to *https://api.hellosign.com/v3* | *SignatureRequestApi* | [**signatureRequestCancel**](./docs/api/SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | | *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](./docs/api/SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | | *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +| *SignatureRequestApi* | [**signatureRequestEdit**](./docs/api/SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +| *SignatureRequestApi* | [**signatureRequestEditEmbedded**](./docs/api/SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +| *SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +| *SignatureRequestApi* | [**signatureRequestEditWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | | *SignatureRequestApi* | [**signatureRequestFiles**](./docs/api/SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files | | *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](./docs/api/SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | | *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](./docs/api/SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -242,6 +246,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SignatureRequestBulkSendWithTemplateRequest](./docs/model/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](./docs/model/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](./docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md) +- [SignatureRequestEditEmbeddedRequest](./docs/model/SignatureRequestEditEmbeddedRequest.md) +- [SignatureRequestEditEmbeddedWithTemplateRequest](./docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md) +- [SignatureRequestEditRequest](./docs/model/SignatureRequestEditRequest.md) +- [SignatureRequestEditWithTemplateRequest](./docs/model/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](./docs/model/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](./docs/model/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](./docs/model/SignatureRequestRemindRequest.md) diff --git a/sdks/node/api/signatureRequestApi.ts b/sdks/node/api/signatureRequestApi.ts index 3fd0d611e..845c9f787 100644 --- a/sdks/node/api/signatureRequestApi.ts +++ b/sdks/node/api/signatureRequestApi.ts @@ -37,6 +37,10 @@ import { SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditRequest, + SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, @@ -824,6 +828,654 @@ export class SignatureRequestApi { ); }); } + /** + * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + * @summary Edit Signature Request + * @param signatureRequestId The id of the SignatureRequest to edit. + * @param signatureRequestEditRequest + * @param options + */ + public async signatureRequestEdit( + signatureRequestId: string, + signatureRequestEditRequest: SignatureRequestEditRequest, + options: optionsI = { headers: {} } + ): Promise> { + signatureRequestEditRequest = deserializeIfNeeded( + signatureRequestEditRequest, + "SignatureRequestEditRequest" + ); + const localVarPath = + this.basePath + + "/signature_request/edit/{signature_request_id}".replace( + "{" + "signature_request_id" + "}", + encodeURIComponent(String(signatureRequestId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'signatureRequestId' is not null or undefined + if (signatureRequestId === null || signatureRequestId === undefined) { + throw new Error( + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEdit." + ); + } + + // verify required parameter 'signatureRequestEditRequest' is not null or undefined + if ( + signatureRequestEditRequest === null || + signatureRequestEditRequest === undefined + ) { + throw new Error( + "Required parameter signatureRequestEditRequest was null or undefined when calling signatureRequestEdit." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + const result = generateFormData( + signatureRequestEditRequest, + SignatureRequestEditRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + + let data = {}; + if (localVarUseFormData) { + const formData = toFormData(result.data); + data = formData; + localVarHeaderParams = { + ...localVarHeaderParams, + ...formData.getHeaders(), + }; + } else { + data = ObjectSerializer.serialize( + signatureRequestEditRequest, + "SignatureRequestEditRequest" + ); + } + + let localVarRequestOptions: AxiosRequestConfig = { + method: "PUT", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data, + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>( + (resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "SignatureRequestGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "SignatureRequestGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + } + ); + }); + } + /** + * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * @summary Edit Embedded Signature Request + * @param signatureRequestId The id of the SignatureRequest to edit. + * @param signatureRequestEditEmbeddedRequest + * @param options + */ + public async signatureRequestEditEmbedded( + signatureRequestId: string, + signatureRequestEditEmbeddedRequest: SignatureRequestEditEmbeddedRequest, + options: optionsI = { headers: {} } + ): Promise> { + signatureRequestEditEmbeddedRequest = deserializeIfNeeded( + signatureRequestEditEmbeddedRequest, + "SignatureRequestEditEmbeddedRequest" + ); + const localVarPath = + this.basePath + + "/signature_request/edit_embedded/{signature_request_id}".replace( + "{" + "signature_request_id" + "}", + encodeURIComponent(String(signatureRequestId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'signatureRequestId' is not null or undefined + if (signatureRequestId === null || signatureRequestId === undefined) { + throw new Error( + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEditEmbedded." + ); + } + + // verify required parameter 'signatureRequestEditEmbeddedRequest' is not null or undefined + if ( + signatureRequestEditEmbeddedRequest === null || + signatureRequestEditEmbeddedRequest === undefined + ) { + throw new Error( + "Required parameter signatureRequestEditEmbeddedRequest was null or undefined when calling signatureRequestEditEmbedded." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + const result = generateFormData( + signatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + + let data = {}; + if (localVarUseFormData) { + const formData = toFormData(result.data); + data = formData; + localVarHeaderParams = { + ...localVarHeaderParams, + ...formData.getHeaders(), + }; + } else { + data = ObjectSerializer.serialize( + signatureRequestEditEmbeddedRequest, + "SignatureRequestEditEmbeddedRequest" + ); + } + + let localVarRequestOptions: AxiosRequestConfig = { + method: "PUT", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data, + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>( + (resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "SignatureRequestGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "SignatureRequestGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + } + ); + }); + } + /** + * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * @summary Edit Embedded Signature Request with Template + * @param signatureRequestId The id of the SignatureRequest to edit. + * @param signatureRequestEditEmbeddedWithTemplateRequest + * @param options + */ + public async signatureRequestEditEmbeddedWithTemplate( + signatureRequestId: string, + signatureRequestEditEmbeddedWithTemplateRequest: SignatureRequestEditEmbeddedWithTemplateRequest, + options: optionsI = { headers: {} } + ): Promise> { + signatureRequestEditEmbeddedWithTemplateRequest = deserializeIfNeeded( + signatureRequestEditEmbeddedWithTemplateRequest, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ); + const localVarPath = + this.basePath + + "/signature_request/edit_embedded_with_template/{signature_request_id}".replace( + "{" + "signature_request_id" + "}", + encodeURIComponent(String(signatureRequestId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'signatureRequestId' is not null or undefined + if (signatureRequestId === null || signatureRequestId === undefined) { + throw new Error( + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEditEmbeddedWithTemplate." + ); + } + + // verify required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' is not null or undefined + if ( + signatureRequestEditEmbeddedWithTemplateRequest === null || + signatureRequestEditEmbeddedWithTemplateRequest === undefined + ) { + throw new Error( + "Required parameter signatureRequestEditEmbeddedWithTemplateRequest was null or undefined when calling signatureRequestEditEmbeddedWithTemplate." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + const result = generateFormData( + signatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedWithTemplateRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + + let data = {}; + if (localVarUseFormData) { + const formData = toFormData(result.data); + data = formData; + localVarHeaderParams = { + ...localVarHeaderParams, + ...formData.getHeaders(), + }; + } else { + data = ObjectSerializer.serialize( + signatureRequestEditEmbeddedWithTemplateRequest, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ); + } + + let localVarRequestOptions: AxiosRequestConfig = { + method: "PUT", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data, + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>( + (resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "SignatureRequestGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "SignatureRequestGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + } + ); + }); + } + /** + * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + * @summary Edit Signature Request With Template + * @param signatureRequestId The id of the SignatureRequest to edit. + * @param signatureRequestEditWithTemplateRequest + * @param options + */ + public async signatureRequestEditWithTemplate( + signatureRequestId: string, + signatureRequestEditWithTemplateRequest: SignatureRequestEditWithTemplateRequest, + options: optionsI = { headers: {} } + ): Promise> { + signatureRequestEditWithTemplateRequest = deserializeIfNeeded( + signatureRequestEditWithTemplateRequest, + "SignatureRequestEditWithTemplateRequest" + ); + const localVarPath = + this.basePath + + "/signature_request/edit_with_template/{signature_request_id}".replace( + "{" + "signature_request_id" + "}", + encodeURIComponent(String(signatureRequestId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'signatureRequestId' is not null or undefined + if (signatureRequestId === null || signatureRequestId === undefined) { + throw new Error( + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEditWithTemplate." + ); + } + + // verify required parameter 'signatureRequestEditWithTemplateRequest' is not null or undefined + if ( + signatureRequestEditWithTemplateRequest === null || + signatureRequestEditWithTemplateRequest === undefined + ) { + throw new Error( + "Required parameter signatureRequestEditWithTemplateRequest was null or undefined when calling signatureRequestEditWithTemplate." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + const result = generateFormData( + signatureRequestEditWithTemplateRequest, + SignatureRequestEditWithTemplateRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + + let data = {}; + if (localVarUseFormData) { + const formData = toFormData(result.data); + data = formData; + localVarHeaderParams = { + ...localVarHeaderParams, + ...formData.getHeaders(), + }; + } else { + data = ObjectSerializer.serialize( + signatureRequestEditWithTemplateRequest, + "SignatureRequestEditWithTemplateRequest" + ); + } + + let localVarRequestOptions: AxiosRequestConfig = { + method: "PUT", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data, + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>( + (resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "SignatureRequestGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "SignatureRequestGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + } + ); + }); + } /** * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. * @summary Download Files diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 3b8851064..13138becb 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -13015,6 +13015,10 @@ __export(api_exports, { SignatureRequestBulkSendWithTemplateRequest: () => SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest: () => SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest: () => SignatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedRequest: () => SignatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedWithTemplateRequest: () => SignatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditRequest: () => SignatureRequestEditRequest, + SignatureRequestEditWithTemplateRequest: () => SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse: () => SignatureRequestGetResponse, SignatureRequestListResponse: () => SignatureRequestListResponse, SignatureRequestRemindRequest: () => SignatureRequestRemindRequest, @@ -19125,6 +19129,497 @@ SignatureRequestCreateEmbeddedWithTemplateRequest.attributeTypeMap = [ } ]; +// model/signatureRequestEditEmbeddedRequest.ts +var _SignatureRequestEditEmbeddedRequest = class { + constructor() { + this["allowDecline"] = false; + this["allowReassign"] = false; + this["hideTextTags"] = false; + this["testMode"] = false; + this["useTextTags"] = false; + this["populateAutoFillFields"] = false; + } + static getAttributeTypeMap() { + return _SignatureRequestEditEmbeddedRequest.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize( + data, + "SignatureRequestEditEmbeddedRequest" + ); + } +}; +var SignatureRequestEditEmbeddedRequest = _SignatureRequestEditEmbeddedRequest; +SignatureRequestEditEmbeddedRequest.discriminator = void 0; +SignatureRequestEditEmbeddedRequest.attributeTypeMap = [ + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "files", + baseName: "files", + type: "Array" + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array" + }, + { + name: "signers", + baseName: "signers", + type: "Array" + }, + { + name: "groupedSigners", + baseName: "grouped_signers", + type: "Array" + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean" + }, + { + name: "allowReassign", + baseName: "allow_reassign", + type: "boolean" + }, + { + name: "attachments", + baseName: "attachments", + type: "Array" + }, + { + name: "ccEmailAddresses", + baseName: "cc_email_addresses", + type: "Array" + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array" + }, + { + name: "fieldOptions", + baseName: "field_options", + type: "SubFieldOptions" + }, + { + name: "formFieldGroups", + baseName: "form_field_groups", + type: "Array" + }, + { + name: "formFieldRules", + baseName: "form_field_rules", + type: "Array" + }, + { + name: "formFieldsPerDocument", + baseName: "form_fields_per_document", + type: "Array" + }, + { + name: "hideTextTags", + baseName: "hide_text_tags", + type: "boolean" + }, + { + name: "message", + baseName: "message", + type: "string" + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }" + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions" + }, + { + name: "subject", + baseName: "subject", + type: "string" + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean" + }, + { + name: "title", + baseName: "title", + type: "string" + }, + { + name: "useTextTags", + baseName: "use_text_tags", + type: "boolean" + }, + { + name: "populateAutoFillFields", + baseName: "populate_auto_fill_fields", + type: "boolean" + }, + { + name: "expiresAt", + baseName: "expires_at", + type: "number" + } +]; + +// model/signatureRequestEditEmbeddedWithTemplateRequest.ts +var _SignatureRequestEditEmbeddedWithTemplateRequest = class { + constructor() { + this["allowDecline"] = false; + this["testMode"] = false; + this["populateAutoFillFields"] = false; + } + static getAttributeTypeMap() { + return _SignatureRequestEditEmbeddedWithTemplateRequest.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize( + data, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ); + } +}; +var SignatureRequestEditEmbeddedWithTemplateRequest = _SignatureRequestEditEmbeddedWithTemplateRequest; +SignatureRequestEditEmbeddedWithTemplateRequest.discriminator = void 0; +SignatureRequestEditEmbeddedWithTemplateRequest.attributeTypeMap = [ + { + name: "templateIds", + baseName: "template_ids", + type: "Array" + }, + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "signers", + baseName: "signers", + type: "Array" + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean" + }, + { + name: "ccs", + baseName: "ccs", + type: "Array" + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array" + }, + { + name: "files", + baseName: "files", + type: "Array" + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array" + }, + { + name: "message", + baseName: "message", + type: "string" + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }" + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions" + }, + { + name: "subject", + baseName: "subject", + type: "string" + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean" + }, + { + name: "title", + baseName: "title", + type: "string" + }, + { + name: "populateAutoFillFields", + baseName: "populate_auto_fill_fields", + type: "boolean" + } +]; + +// model/signatureRequestEditRequest.ts +var _SignatureRequestEditRequest = class { + constructor() { + this["allowDecline"] = false; + this["allowReassign"] = false; + this["hideTextTags"] = false; + this["isEid"] = false; + this["testMode"] = false; + this["useTextTags"] = false; + } + static getAttributeTypeMap() { + return _SignatureRequestEditRequest.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "SignatureRequestEditRequest"); + } +}; +var SignatureRequestEditRequest = _SignatureRequestEditRequest; +SignatureRequestEditRequest.discriminator = void 0; +SignatureRequestEditRequest.attributeTypeMap = [ + { + name: "files", + baseName: "files", + type: "Array" + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array" + }, + { + name: "signers", + baseName: "signers", + type: "Array" + }, + { + name: "groupedSigners", + baseName: "grouped_signers", + type: "Array" + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean" + }, + { + name: "allowReassign", + baseName: "allow_reassign", + type: "boolean" + }, + { + name: "attachments", + baseName: "attachments", + type: "Array" + }, + { + name: "ccEmailAddresses", + baseName: "cc_email_addresses", + type: "Array" + }, + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array" + }, + { + name: "fieldOptions", + baseName: "field_options", + type: "SubFieldOptions" + }, + { + name: "formFieldGroups", + baseName: "form_field_groups", + type: "Array" + }, + { + name: "formFieldRules", + baseName: "form_field_rules", + type: "Array" + }, + { + name: "formFieldsPerDocument", + baseName: "form_fields_per_document", + type: "Array" + }, + { + name: "hideTextTags", + baseName: "hide_text_tags", + type: "boolean" + }, + { + name: "isEid", + baseName: "is_eid", + type: "boolean" + }, + { + name: "message", + baseName: "message", + type: "string" + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }" + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions" + }, + { + name: "signingRedirectUrl", + baseName: "signing_redirect_url", + type: "string" + }, + { + name: "subject", + baseName: "subject", + type: "string" + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean" + }, + { + name: "title", + baseName: "title", + type: "string" + }, + { + name: "useTextTags", + baseName: "use_text_tags", + type: "boolean" + }, + { + name: "expiresAt", + baseName: "expires_at", + type: "number" + } +]; + +// model/signatureRequestEditWithTemplateRequest.ts +var _SignatureRequestEditWithTemplateRequest = class { + constructor() { + this["allowDecline"] = false; + this["isEid"] = false; + this["testMode"] = false; + } + static getAttributeTypeMap() { + return _SignatureRequestEditWithTemplateRequest.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize( + data, + "SignatureRequestEditWithTemplateRequest" + ); + } +}; +var SignatureRequestEditWithTemplateRequest = _SignatureRequestEditWithTemplateRequest; +SignatureRequestEditWithTemplateRequest.discriminator = void 0; +SignatureRequestEditWithTemplateRequest.attributeTypeMap = [ + { + name: "templateIds", + baseName: "template_ids", + type: "Array" + }, + { + name: "signers", + baseName: "signers", + type: "Array" + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean" + }, + { + name: "ccs", + baseName: "ccs", + type: "Array" + }, + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array" + }, + { + name: "files", + baseName: "files", + type: "Array" + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array" + }, + { + name: "isEid", + baseName: "is_eid", + type: "boolean" + }, + { + name: "message", + baseName: "message", + type: "string" + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }" + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions" + }, + { + name: "signingRedirectUrl", + baseName: "signing_redirect_url", + type: "string" + }, + { + name: "subject", + baseName: "subject", + type: "string" + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean" + }, + { + name: "title", + baseName: "title", + type: "string" + } +]; + // model/signatureRequestGetResponse.ts var _SignatureRequestGetResponse = class { static getAttributeTypeMap() { @@ -24788,6 +25283,10 @@ var typeMap = { SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditRequest, + SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, @@ -28148,13 +28647,203 @@ var OAuthApi = class { }); }); } - oauthTokenRefresh(_0) { - return __async(this, arguments, function* (oAuthTokenRefreshRequest, options = { headers: {} }) { - oAuthTokenRefreshRequest = deserializeIfNeeded6( - oAuthTokenRefreshRequest, - "OAuthTokenRefreshRequest" + oauthTokenRefresh(_0) { + return __async(this, arguments, function* (oAuthTokenRefreshRequest, options = { headers: {} }) { + oAuthTokenRefreshRequest = deserializeIfNeeded6( + oAuthTokenRefreshRequest, + "OAuthTokenRefreshRequest" + ); + const localVarPath = this.basePath + "/oauth/token?refresh"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (oAuthTokenRefreshRequest === null || oAuthTokenRefreshRequest === void 0) { + throw new Error( + "Required parameter oAuthTokenRefreshRequest was null or undefined when calling oauthTokenRefresh." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + oAuthTokenRefreshRequest, + OAuthTokenRefreshRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize( + oAuthTokenRefreshRequest, + "OAuthTokenRefreshRequest" + ); + } + let localVarRequestOptions = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse7( + resolve, + reject, + response, + "OAuthTokenResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse7( + reject, + error.response, + 200, + "OAuthTokenResponse" + )) { + return; + } + if (handleErrorRangeResponse7( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } +}; +function deserializeIfNeeded6(obj, classname) { + if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { + return ObjectSerializer.deserialize(obj, classname); + } + return obj; +} +function handleSuccessfulResponse7(resolve, reject, response, returnType) { + let body = response.data; + if (response.status && response.status >= 200 && response.status <= 299) { + if (returnType) { + body = ObjectSerializer.deserialize(body, returnType); + } + resolve({ response, body }); + } else { + reject(new HttpError(response, body, response.status)); + } +} +function handleErrorCodeResponse7(reject, response, code, returnType) { + if (response.status !== code) { + return false; + } + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; +} +function handleErrorRangeResponse7(reject, response, code, returnType) { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; + } + return false; +} + +// api/reportApi.ts +var defaultBasePath8 = "https://api.hellosign.com/v3"; +var ReportApi = class { + constructor(basePath) { + this._basePath = defaultBasePath8; + this._defaultHeaders = { "User-Agent": USER_AGENT }; + this._useQuerystring = false; + this.authentications = { + default: new VoidAuth(), + api_key: new HttpBasicAuth(), + oauth2: new HttpBearerAuth() + }; + this.interceptors = []; + if (basePath) { + this.basePath = basePath; + } + } + set useQuerystring(value) { + this._useQuerystring = value; + } + set basePath(basePath) { + this._basePath = basePath; + } + set defaultHeaders(defaultHeaders) { + this._defaultHeaders = __spreadProps(__spreadValues({}, defaultHeaders), { "User-Agent": USER_AGENT }); + } + get defaultHeaders() { + return this._defaultHeaders; + } + get basePath() { + return this._basePath; + } + setDefaultAuthentication(auth) { + this.authentications.default = auth; + } + setApiKey(key) { + this.authentications.api_key.username = key; + } + set username(username) { + this.authentications.api_key.username = username; + } + set password(password) { + this.authentications.api_key.password = password; + } + set accessToken(accessToken) { + this.authentications.oauth2.accessToken = accessToken; + } + addInterceptor(interceptor) { + this.interceptors.push(interceptor); + } + reportCreate(_0) { + return __async(this, arguments, function* (reportCreateRequest, options = { headers: {} }) { + reportCreateRequest = deserializeIfNeeded7( + reportCreateRequest, + "ReportCreateRequest" ); - const localVarPath = this.basePath + "/oauth/token?refresh"; + const localVarPath = this.basePath + "/report/create"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -28168,16 +28857,16 @@ var OAuthApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (oAuthTokenRefreshRequest === null || oAuthTokenRefreshRequest === void 0) { + if (reportCreateRequest === null || reportCreateRequest === void 0) { throw new Error( - "Required parameter oAuthTokenRefreshRequest was null or undefined when calling oauthTokenRefresh." + "Required parameter reportCreateRequest was null or undefined when calling reportCreate." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; const result = generateFormData( - oAuthTokenRefreshRequest, - OAuthTokenRefreshRequest.attributeTypeMap + reportCreateRequest, + ReportCreateRequest.attributeTypeMap ); localVarUseFormData = result.localVarUseFormData; let data = {}; @@ -28187,8 +28876,8 @@ var OAuthApi = class { localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); } else { data = ObjectSerializer.serialize( - oAuthTokenRefreshRequest, - "OAuthTokenRefreshRequest" + reportCreateRequest, + "ReportCreateRequest" ); } let localVarRequestOptions = { @@ -28203,6 +28892,11 @@ var OAuthApi = class { data }; let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } authenticationPromise = authenticationPromise.then( () => this.authentications.default.applyToRequest(localVarRequestOptions) ); @@ -28213,52 +28907,54 @@ var OAuthApi = class { ); } return interceptorPromise.then(() => { - return new Promise((resolve, reject) => { - axios_default.request(localVarRequestOptions).then( - (response) => { - handleSuccessfulResponse7( - resolve, - reject, - response, - "OAuthTokenResponse" - ); - }, - (error) => { - if (error.response == null) { + return new Promise( + (resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse8( + resolve, + reject, + response, + "ReportCreateResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse8( + reject, + error.response, + 200, + "ReportCreateResponse" + )) { + return; + } + if (handleErrorRangeResponse8( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); - return; - } - if (handleErrorCodeResponse7( - reject, - error.response, - 200, - "OAuthTokenResponse" - )) { - return; } - if (handleErrorRangeResponse7( - reject, - error.response, - "4XX", - "ErrorResponse" - )) { - return; - } - reject(error); - } - ); - }); + ); + } + ); }); }); } }; -function deserializeIfNeeded6(obj, classname) { +function deserializeIfNeeded7(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse7(resolve, reject, response, returnType) { +function handleSuccessfulResponse8(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -28269,7 +28965,7 @@ function handleSuccessfulResponse7(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse7(reject, response, code, returnType) { +function handleErrorCodeResponse8(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -28277,7 +28973,7 @@ function handleErrorCodeResponse7(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse7(reject, response, code, returnType) { +function handleErrorRangeResponse8(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -28288,11 +28984,11 @@ function handleErrorRangeResponse7(reject, response, code, returnType) { return false; } -// api/reportApi.ts -var defaultBasePath8 = "https://api.hellosign.com/v3"; -var ReportApi = class { +// api/signatureRequestApi.ts +var defaultBasePath9 = "https://api.hellosign.com/v3"; +var SignatureRequestApi = class { constructor(basePath) { - this._basePath = defaultBasePath8; + this._basePath = defaultBasePath9; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -28338,13 +29034,123 @@ var ReportApi = class { addInterceptor(interceptor) { this.interceptors.push(interceptor); } - reportCreate(_0) { - return __async(this, arguments, function* (reportCreateRequest, options = { headers: {} }) { - reportCreateRequest = deserializeIfNeeded7( - reportCreateRequest, - "ReportCreateRequest" + signatureRequestBulkCreateEmbeddedWithTemplate(_0) { + return __async(this, arguments, function* (signatureRequestBulkCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { + signatureRequestBulkCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, + "SignatureRequestBulkCreateEmbeddedWithTemplateRequest" + ); + const localVarPath = this.basePath + "/signature_request/bulk_create_embedded_with_template"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (signatureRequestBulkCreateEmbeddedWithTemplateRequest === null || signatureRequestBulkCreateEmbeddedWithTemplateRequest === void 0) { + throw new Error( + "Required parameter signatureRequestBulkCreateEmbeddedWithTemplateRequest was null or undefined when calling signatureRequestBulkCreateEmbeddedWithTemplate." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, + SignatureRequestBulkCreateEmbeddedWithTemplateRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, + "SignatureRequestBulkCreateEmbeddedWithTemplateRequest" + ); + } + let localVarRequestOptions = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise( + (resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse9( + resolve, + reject, + response, + "BulkSendJobSendResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse9( + reject, + error.response, + 200, + "BulkSendJobSendResponse" + )) { + return; + } + if (handleErrorRangeResponse9( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + } + ); + }); + }); + } + signatureRequestBulkSendWithTemplate(_0) { + return __async(this, arguments, function* (signatureRequestBulkSendWithTemplateRequest, options = { headers: {} }) { + signatureRequestBulkSendWithTemplateRequest = deserializeIfNeeded8( + signatureRequestBulkSendWithTemplateRequest, + "SignatureRequestBulkSendWithTemplateRequest" ); - const localVarPath = this.basePath + "/report/create"; + const localVarPath = this.basePath + "/signature_request/bulk_send_with_template"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -28358,16 +29164,16 @@ var ReportApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (reportCreateRequest === null || reportCreateRequest === void 0) { + if (signatureRequestBulkSendWithTemplateRequest === null || signatureRequestBulkSendWithTemplateRequest === void 0) { throw new Error( - "Required parameter reportCreateRequest was null or undefined when calling reportCreate." + "Required parameter signatureRequestBulkSendWithTemplateRequest was null or undefined when calling signatureRequestBulkSendWithTemplate." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; const result = generateFormData( - reportCreateRequest, - ReportCreateRequest.attributeTypeMap + signatureRequestBulkSendWithTemplateRequest, + SignatureRequestBulkSendWithTemplateRequest.attributeTypeMap ); localVarUseFormData = result.localVarUseFormData; let data = {}; @@ -28377,8 +29183,8 @@ var ReportApi = class { localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); } else { data = ObjectSerializer.serialize( - reportCreateRequest, - "ReportCreateRequest" + signatureRequestBulkSendWithTemplateRequest, + "SignatureRequestBulkSendWithTemplateRequest" ); } let localVarRequestOptions = { @@ -28398,6 +29204,11 @@ var ReportApi = class { () => this.authentications.api_key.applyToRequest(localVarRequestOptions) ); } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } authenticationPromise = authenticationPromise.then( () => this.authentications.default.applyToRequest(localVarRequestOptions) ); @@ -28412,11 +29223,11 @@ var ReportApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, - "ReportCreateResponse" + "BulkSendJobSendResponse" ); }, (error) => { @@ -28424,15 +29235,15 @@ var ReportApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, - "ReportCreateResponse" + "BulkSendJobSendResponse" )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28448,100 +29259,210 @@ var ReportApi = class { }); }); } -}; -function deserializeIfNeeded7(obj, classname) { - if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { - return ObjectSerializer.deserialize(obj, classname); - } - return obj; -} -function handleSuccessfulResponse8(resolve, reject, response, returnType) { - let body = response.data; - if (response.status && response.status >= 200 && response.status <= 299) { - if (returnType) { - body = ObjectSerializer.deserialize(body, returnType); - } - resolve({ response, body }); - } else { - reject(new HttpError(response, body, response.status)); - } -} -function handleErrorCodeResponse8(reject, response, code, returnType) { - if (response.status !== code) { - return false; - } - const body = ObjectSerializer.deserialize(response.data, returnType); - reject(new HttpError(response, body, response.status)); - return true; -} -function handleErrorRangeResponse8(reject, response, code, returnType) { - let rangeCodeLeft = Number(code[0] + "00"); - let rangeCodeRight = Number(code[0] + "99"); - if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { - const body = ObjectSerializer.deserialize(response.data, returnType); - reject(new HttpError(response, body, response.status)); - return true; - } - return false; -} - -// api/signatureRequestApi.ts -var defaultBasePath9 = "https://api.hellosign.com/v3"; -var SignatureRequestApi = class { - constructor(basePath) { - this._basePath = defaultBasePath9; - this._defaultHeaders = { "User-Agent": USER_AGENT }; - this._useQuerystring = false; - this.authentications = { - default: new VoidAuth(), - api_key: new HttpBasicAuth(), - oauth2: new HttpBearerAuth() - }; - this.interceptors = []; - if (basePath) { - this.basePath = basePath; - } - } - set useQuerystring(value) { - this._useQuerystring = value; - } - set basePath(basePath) { - this._basePath = basePath; - } - set defaultHeaders(defaultHeaders) { - this._defaultHeaders = __spreadProps(__spreadValues({}, defaultHeaders), { "User-Agent": USER_AGENT }); - } - get defaultHeaders() { - return this._defaultHeaders; - } - get basePath() { - return this._basePath; - } - setDefaultAuthentication(auth) { - this.authentications.default = auth; - } - setApiKey(key) { - this.authentications.api_key.username = key; - } - set username(username) { - this.authentications.api_key.username = username; - } - set password(password) { - this.authentications.api_key.password = password; - } - set accessToken(accessToken) { - this.authentications.oauth2.accessToken = accessToken; + signatureRequestCancel(_0) { + return __async(this, arguments, function* (signatureRequestId, options = { headers: {} }) { + const localVarPath = this.basePath + "/signature_request/cancel/{signature_request_id}".replace( + "{signature_request_id}", + encodeURIComponent(String(signatureRequestId)) + ); + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (signatureRequestId === null || signatureRequestId === void 0) { + throw new Error( + "Required parameter signatureRequestId was null or undefined when calling signatureRequestCancel." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse9(resolve, reject, response); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorRangeResponse9( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); } - addInterceptor(interceptor) { - this.interceptors.push(interceptor); + signatureRequestCreateEmbedded(_0) { + return __async(this, arguments, function* (signatureRequestCreateEmbeddedRequest, options = { headers: {} }) { + signatureRequestCreateEmbeddedRequest = deserializeIfNeeded8( + signatureRequestCreateEmbeddedRequest, + "SignatureRequestCreateEmbeddedRequest" + ); + const localVarPath = this.basePath + "/signature_request/create_embedded"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (signatureRequestCreateEmbeddedRequest === null || signatureRequestCreateEmbeddedRequest === void 0) { + throw new Error( + "Required parameter signatureRequestCreateEmbeddedRequest was null or undefined when calling signatureRequestCreateEmbedded." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + signatureRequestCreateEmbeddedRequest, + SignatureRequestCreateEmbeddedRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize( + signatureRequestCreateEmbeddedRequest, + "SignatureRequestCreateEmbeddedRequest" + ); + } + let localVarRequestOptions = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise( + (resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse9( + resolve, + reject, + response, + "SignatureRequestGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse9( + reject, + error.response, + 200, + "SignatureRequestGetResponse" + )) { + return; + } + if (handleErrorRangeResponse9( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + } + ); + }); + }); } - signatureRequestBulkCreateEmbeddedWithTemplate(_0) { - return __async(this, arguments, function* (signatureRequestBulkCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - signatureRequestBulkCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( - signatureRequestBulkCreateEmbeddedWithTemplateRequest, - "SignatureRequestBulkCreateEmbeddedWithTemplateRequest" + signatureRequestCreateEmbeddedWithTemplate(_0) { + return __async(this, arguments, function* (signatureRequestCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { + signatureRequestCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( + signatureRequestCreateEmbeddedWithTemplateRequest, + "SignatureRequestCreateEmbeddedWithTemplateRequest" ); - const localVarPath = this.basePath + "/signature_request/bulk_create_embedded_with_template"; + const localVarPath = this.basePath + "/signature_request/create_embedded_with_template"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -28555,16 +29476,16 @@ var SignatureRequestApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (signatureRequestBulkCreateEmbeddedWithTemplateRequest === null || signatureRequestBulkCreateEmbeddedWithTemplateRequest === void 0) { + if (signatureRequestCreateEmbeddedWithTemplateRequest === null || signatureRequestCreateEmbeddedWithTemplateRequest === void 0) { throw new Error( - "Required parameter signatureRequestBulkCreateEmbeddedWithTemplateRequest was null or undefined when calling signatureRequestBulkCreateEmbeddedWithTemplate." + "Required parameter signatureRequestCreateEmbeddedWithTemplateRequest was null or undefined when calling signatureRequestCreateEmbeddedWithTemplate." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; const result = generateFormData( - signatureRequestBulkCreateEmbeddedWithTemplateRequest, - SignatureRequestBulkCreateEmbeddedWithTemplateRequest.attributeTypeMap + signatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestCreateEmbeddedWithTemplateRequest.attributeTypeMap ); localVarUseFormData = result.localVarUseFormData; let data = {}; @@ -28574,8 +29495,8 @@ var SignatureRequestApi = class { localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); } else { data = ObjectSerializer.serialize( - signatureRequestBulkCreateEmbeddedWithTemplateRequest, - "SignatureRequestBulkCreateEmbeddedWithTemplateRequest" + signatureRequestCreateEmbeddedWithTemplateRequest, + "SignatureRequestCreateEmbeddedWithTemplateRequest" ); } let localVarRequestOptions = { @@ -28595,6 +29516,11 @@ var SignatureRequestApi = class { () => this.authentications.api_key.applyToRequest(localVarRequestOptions) ); } + if (this.authentications.oauth2.accessToken) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.oauth2.applyToRequest(localVarRequestOptions) + ); + } authenticationPromise = authenticationPromise.then( () => this.authentications.default.applyToRequest(localVarRequestOptions) ); @@ -28613,7 +29539,7 @@ var SignatureRequestApi = class { resolve, reject, response, - "BulkSendJobSendResponse" + "SignatureRequestGetResponse" ); }, (error) => { @@ -28625,7 +29551,7 @@ var SignatureRequestApi = class { reject, error.response, 200, - "BulkSendJobSendResponse" + "SignatureRequestGetResponse" )) { return; } @@ -28645,13 +29571,16 @@ var SignatureRequestApi = class { }); }); } - signatureRequestBulkSendWithTemplate(_0) { - return __async(this, arguments, function* (signatureRequestBulkSendWithTemplateRequest, options = { headers: {} }) { - signatureRequestBulkSendWithTemplateRequest = deserializeIfNeeded8( - signatureRequestBulkSendWithTemplateRequest, - "SignatureRequestBulkSendWithTemplateRequest" + signatureRequestEdit(_0, _1) { + return __async(this, arguments, function* (signatureRequestId, signatureRequestEditRequest, options = { headers: {} }) { + signatureRequestEditRequest = deserializeIfNeeded8( + signatureRequestEditRequest, + "SignatureRequestEditRequest" + ); + const localVarPath = this.basePath + "/signature_request/edit/{signature_request_id}".replace( + "{signature_request_id}", + encodeURIComponent(String(signatureRequestId)) ); - const localVarPath = this.basePath + "/signature_request/bulk_send_with_template"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -28665,16 +29594,21 @@ var SignatureRequestApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (signatureRequestBulkSendWithTemplateRequest === null || signatureRequestBulkSendWithTemplateRequest === void 0) { + if (signatureRequestId === null || signatureRequestId === void 0) { throw new Error( - "Required parameter signatureRequestBulkSendWithTemplateRequest was null or undefined when calling signatureRequestBulkSendWithTemplate." + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEdit." + ); + } + if (signatureRequestEditRequest === null || signatureRequestEditRequest === void 0) { + throw new Error( + "Required parameter signatureRequestEditRequest was null or undefined when calling signatureRequestEdit." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; const result = generateFormData( - signatureRequestBulkSendWithTemplateRequest, - SignatureRequestBulkSendWithTemplateRequest.attributeTypeMap + signatureRequestEditRequest, + SignatureRequestEditRequest.attributeTypeMap ); localVarUseFormData = result.localVarUseFormData; let data = {}; @@ -28684,12 +29618,12 @@ var SignatureRequestApi = class { localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); } else { data = ObjectSerializer.serialize( - signatureRequestBulkSendWithTemplateRequest, - "SignatureRequestBulkSendWithTemplateRequest" + signatureRequestEditRequest, + "SignatureRequestEditRequest" ); } let localVarRequestOptions = { - method: "POST", + method: "PUT", params: localVarQueryParameters, headers: localVarHeaderParams, url: localVarPath, @@ -28728,7 +29662,7 @@ var SignatureRequestApi = class { resolve, reject, response, - "BulkSendJobSendResponse" + "SignatureRequestGetResponse" ); }, (error) => { @@ -28740,7 +29674,7 @@ var SignatureRequestApi = class { reject, error.response, 200, - "BulkSendJobSendResponse" + "SignatureRequestGetResponse" )) { return; } @@ -28760,9 +29694,13 @@ var SignatureRequestApi = class { }); }); } - signatureRequestCancel(_0) { - return __async(this, arguments, function* (signatureRequestId, options = { headers: {} }) { - const localVarPath = this.basePath + "/signature_request/cancel/{signature_request_id}".replace( + signatureRequestEditEmbedded(_0, _1) { + return __async(this, arguments, function* (signatureRequestId, signatureRequestEditEmbeddedRequest, options = { headers: {} }) { + signatureRequestEditEmbeddedRequest = deserializeIfNeeded8( + signatureRequestEditEmbeddedRequest, + "SignatureRequestEditEmbeddedRequest" + ); + const localVarPath = this.basePath + "/signature_request/edit_embedded/{signature_request_id}".replace( "{signature_request_id}", encodeURIComponent(String(signatureRequestId)) ); @@ -28781,20 +29719,42 @@ var SignatureRequestApi = class { let localVarBodyParams = void 0; if (signatureRequestId === null || signatureRequestId === void 0) { throw new Error( - "Required parameter signatureRequestId was null or undefined when calling signatureRequestCancel." + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEditEmbedded." + ); + } + if (signatureRequestEditEmbeddedRequest === null || signatureRequestEditEmbeddedRequest === void 0) { + throw new Error( + "Required parameter signatureRequestEditEmbeddedRequest was null or undefined when calling signatureRequestEditEmbedded." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; + const result = generateFormData( + signatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize( + signatureRequestEditEmbeddedRequest, + "SignatureRequestEditEmbeddedRequest" + ); + } let localVarRequestOptions = { - method: "POST", + method: "PUT", params: localVarQueryParameters, headers: localVarHeaderParams, url: localVarPath, paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, maxContentLength: Infinity, maxBodyLength: Infinity, - responseType: "json" + responseType: "json", + data }; let authenticationPromise = Promise.resolve(); if (this.authentications.api_key.username) { @@ -28817,38 +29777,56 @@ var SignatureRequestApi = class { ); } return interceptorPromise.then(() => { - return new Promise((resolve, reject) => { - axios_default.request(localVarRequestOptions).then( - (response) => { - handleSuccessfulResponse9(resolve, reject, response); - }, - (error) => { - if (error.response == null) { + return new Promise( + (resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse9( + resolve, + reject, + response, + "SignatureRequestGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse9( + reject, + error.response, + 200, + "SignatureRequestGetResponse" + )) { + return; + } + if (handleErrorRangeResponse9( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); - return; - } - if (handleErrorRangeResponse9( - reject, - error.response, - "4XX", - "ErrorResponse" - )) { - return; } - reject(error); - } - ); - }); + ); + } + ); }); }); } - signatureRequestCreateEmbedded(_0) { - return __async(this, arguments, function* (signatureRequestCreateEmbeddedRequest, options = { headers: {} }) { - signatureRequestCreateEmbeddedRequest = deserializeIfNeeded8( - signatureRequestCreateEmbeddedRequest, - "SignatureRequestCreateEmbeddedRequest" + signatureRequestEditEmbeddedWithTemplate(_0, _1) { + return __async(this, arguments, function* (signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest, options = { headers: {} }) { + signatureRequestEditEmbeddedWithTemplateRequest = deserializeIfNeeded8( + signatureRequestEditEmbeddedWithTemplateRequest, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ); + const localVarPath = this.basePath + "/signature_request/edit_embedded_with_template/{signature_request_id}".replace( + "{signature_request_id}", + encodeURIComponent(String(signatureRequestId)) ); - const localVarPath = this.basePath + "/signature_request/create_embedded"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -28862,16 +29840,21 @@ var SignatureRequestApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (signatureRequestCreateEmbeddedRequest === null || signatureRequestCreateEmbeddedRequest === void 0) { + if (signatureRequestId === null || signatureRequestId === void 0) { throw new Error( - "Required parameter signatureRequestCreateEmbeddedRequest was null or undefined when calling signatureRequestCreateEmbedded." + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEditEmbeddedWithTemplate." + ); + } + if (signatureRequestEditEmbeddedWithTemplateRequest === null || signatureRequestEditEmbeddedWithTemplateRequest === void 0) { + throw new Error( + "Required parameter signatureRequestEditEmbeddedWithTemplateRequest was null or undefined when calling signatureRequestEditEmbeddedWithTemplate." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; const result = generateFormData( - signatureRequestCreateEmbeddedRequest, - SignatureRequestCreateEmbeddedRequest.attributeTypeMap + signatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedWithTemplateRequest.attributeTypeMap ); localVarUseFormData = result.localVarUseFormData; let data = {}; @@ -28881,12 +29864,12 @@ var SignatureRequestApi = class { localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); } else { data = ObjectSerializer.serialize( - signatureRequestCreateEmbeddedRequest, - "SignatureRequestCreateEmbeddedRequest" + signatureRequestEditEmbeddedWithTemplateRequest, + "SignatureRequestEditEmbeddedWithTemplateRequest" ); } let localVarRequestOptions = { - method: "POST", + method: "PUT", params: localVarQueryParameters, headers: localVarHeaderParams, url: localVarPath, @@ -28957,13 +29940,16 @@ var SignatureRequestApi = class { }); }); } - signatureRequestCreateEmbeddedWithTemplate(_0) { - return __async(this, arguments, function* (signatureRequestCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - signatureRequestCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( - signatureRequestCreateEmbeddedWithTemplateRequest, - "SignatureRequestCreateEmbeddedWithTemplateRequest" + signatureRequestEditWithTemplate(_0, _1) { + return __async(this, arguments, function* (signatureRequestId, signatureRequestEditWithTemplateRequest, options = { headers: {} }) { + signatureRequestEditWithTemplateRequest = deserializeIfNeeded8( + signatureRequestEditWithTemplateRequest, + "SignatureRequestEditWithTemplateRequest" + ); + const localVarPath = this.basePath + "/signature_request/edit_with_template/{signature_request_id}".replace( + "{signature_request_id}", + encodeURIComponent(String(signatureRequestId)) ); - const localVarPath = this.basePath + "/signature_request/create_embedded_with_template"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -28977,16 +29963,21 @@ var SignatureRequestApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (signatureRequestCreateEmbeddedWithTemplateRequest === null || signatureRequestCreateEmbeddedWithTemplateRequest === void 0) { + if (signatureRequestId === null || signatureRequestId === void 0) { throw new Error( - "Required parameter signatureRequestCreateEmbeddedWithTemplateRequest was null or undefined when calling signatureRequestCreateEmbeddedWithTemplate." + "Required parameter signatureRequestId was null or undefined when calling signatureRequestEditWithTemplate." + ); + } + if (signatureRequestEditWithTemplateRequest === null || signatureRequestEditWithTemplateRequest === void 0) { + throw new Error( + "Required parameter signatureRequestEditWithTemplateRequest was null or undefined when calling signatureRequestEditWithTemplate." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; const result = generateFormData( - signatureRequestCreateEmbeddedWithTemplateRequest, - SignatureRequestCreateEmbeddedWithTemplateRequest.attributeTypeMap + signatureRequestEditWithTemplateRequest, + SignatureRequestEditWithTemplateRequest.attributeTypeMap ); localVarUseFormData = result.localVarUseFormData; let data = {}; @@ -28996,12 +29987,12 @@ var SignatureRequestApi = class { localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); } else { data = ObjectSerializer.serialize( - signatureRequestCreateEmbeddedWithTemplateRequest, - "SignatureRequestCreateEmbeddedWithTemplateRequest" + signatureRequestEditWithTemplateRequest, + "SignatureRequestEditWithTemplateRequest" ); } let localVarRequestOptions = { - method: "POST", + method: "PUT", params: localVarQueryParameters, headers: localVarHeaderParams, url: localVarPath, @@ -33378,6 +34369,10 @@ var APIS = [ SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditRequest, + SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, diff --git a/sdks/node/docs/api/SignatureRequestApi.md b/sdks/node/docs/api/SignatureRequestApi.md index 459c8c120..851264e7b 100644 --- a/sdks/node/docs/api/SignatureRequestApi.md +++ b/sdks/node/docs/api/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to https://api.hellosign.com/v3. | [**signatureRequestCancel()**](SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | | [**signatureRequestCreateEmbedded()**](SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | | [**signatureRequestCreateEmbeddedWithTemplate()**](SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +| [**signatureRequestEdit()**](SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +| [**signatureRequestEditEmbedded()**](SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +| [**signatureRequestEditEmbeddedWithTemplate()**](SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +| [**signatureRequestEditWithTemplate()**](SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | | [**signatureRequestFiles()**](SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files | | [**signatureRequestFilesAsDataUri()**](SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | | [**signatureRequestFilesAsFileUrl()**](SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -732,6 +736,685 @@ result.then(response => { [[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `signatureRequestEdit()` + +```typescript +signatureRequestEdit(signatureRequestId: string, signatureRequestEditRequest: SignatureRequestEditRequest): SignatureRequestGetResponse +``` + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1: DropboxSign.SubSignatureRequestSigner = { + emailAddress: "jack@example.com", + name: "Jack", + order: 0, +}; + +const signer2: DropboxSign.SubSignatureRequestSigner = { + emailAddress: "jill@example.com", + name: "Jill", + order: 1, +}; + +const signingOptions: DropboxSign.SubSigningOptions = { + draw: true, + type: true, + upload: true, + phone: false, + defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, +}; + +const fieldOptions: DropboxSign.SubFieldOptions = { + dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, +}; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer: DropboxSign.RequestDetailedFile = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt: DropboxSign.RequestDetailedFile = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data: DropboxSign.SignatureRequestEditRequest = { + title: "NDA with Acme Co.", + subject: "The NDA we talked about", + message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers: [ signer1, signer2 ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: [ file, fileBuffer, fileBufferAlt ], + metadata: { + "custom_id": 1234, + "custom_text": "NDA #9", + }, + signingOptions, + fieldOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + + +const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1: DropboxSign.SubSignatureRequestSigner = { + emailAddress: "jack@example.com", + name: "Jack", + order: 0, +}; + +const signer2: DropboxSign.SubSignatureRequestSigner = { + emailAddress: "jill@example.com", + name: "Jill", + order: 1, +}; + +const signingOptions: DropboxSign.SubSigningOptions = { + draw: true, + type: true, + upload: true, + phone: false, + defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, +}; + +const fieldOptions: DropboxSign.SubFieldOptions = { + dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, +}; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer: DropboxSign.RequestDetailedFile = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt: DropboxSign.RequestDetailedFile = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data: DropboxSign.SignatureRequestEditRequest = { + title: "NDA with Acme Co.", + subject: "The NDA we talked about", + message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers: [ signer1, signer2 ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: [ file, fileBuffer, fileBufferAlt ], + metadata: { + "custom_id": 1234, + "custom_text": "NDA #9", + }, + signingOptions, + fieldOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signatureRequestId** | **string**| The id of the SignatureRequest to edit. | | +| **signatureRequestEditRequest** | [**SignatureRequestEditRequest**](../model/SignatureRequestEditRequest.md)| | | + +### Return type + +[**SignatureRequestGetResponse**](../model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `signatureRequestEditEmbedded()` + +```typescript +signatureRequestEditEmbedded(signatureRequestId: string, signatureRequestEditEmbeddedRequest: SignatureRequestEditEmbeddedRequest): SignatureRequestGetResponse +``` + +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1: DropboxSign.SubSignatureRequestSigner = { + emailAddress: "jack@example.com", + name: "Jack", + order: 0, +}; + +const signer2: DropboxSign.SubSignatureRequestSigner = { + emailAddress: "jill@example.com", + name: "Jill", + order: 1, +}; + +const signingOptions: DropboxSign.SubSigningOptions = { + draw: true, + type: true, + upload: true, + phone: true, + defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, +}; + +const data: DropboxSign.SignatureRequestEditEmbeddedRequest = { + clientId: "ec64a202072370a737edf4a0eb7f4437", + title: "NDA with Acme Co.", + subject: "The NDA we talked about", + message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers: [ signer1, signer2 ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: [fs.createReadStream("example_signature_request.pdf")], + signingOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEditEmbedded( + signatureRequestId, + data +); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1 = { + emailAddress: "jack@example.com", + name: "Jack", + order: 0, +}; + +const signer2 = { + emailAddress: "jill@example.com", + name: "Jill", + order: 1, +}; + +const signingOptions = { + draw: true, + type: true, + upload: true, + phone: true, + defaultType: "draw", +}; + +const data = { + clientId: "ec64a202072370a737edf4a0eb7f4437", + title: "NDA with Acme Co.", + subject: "The NDA we talked about", + message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers: [ signer1, signer2 ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@example.com", + ], + files: [fs.createReadStream("example_signature_request.pdf")], + signingOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEditEmbedded( + signatureRequestId, + data +); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signatureRequestId** | **string**| The id of the SignatureRequest to edit. | | +| **signatureRequestEditEmbeddedRequest** | [**SignatureRequestEditEmbeddedRequest**](../model/SignatureRequestEditEmbeddedRequest.md)| | | + +### Return type + +[**SignatureRequestGetResponse**](../model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `signatureRequestEditEmbeddedWithTemplate()` + +```typescript +signatureRequestEditEmbeddedWithTemplate(signatureRequestId: string, signatureRequestEditEmbeddedWithTemplateRequest: SignatureRequestEditEmbeddedWithTemplateRequest): SignatureRequestGetResponse +``` + +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { + role: "Client", + emailAddress: "george@example.com", + name: "George", +}; + +const signingOptions: DropboxSign.SubSigningOptions = { + draw: true, + type: true, + upload: true, + phone: false, + defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, +}; + +const data: DropboxSign.SignatureRequestEditEmbeddedWithTemplateRequest = { + clientId: "ec64a202072370a737edf4a0eb7f4437", + templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], + subject: "Purchase Order", + message: "Glad we could come to an agreement.", + signers: [ signer1 ], + signingOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( + signatureRequestId, + data +); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1 = { + role: "Client", + emailAddress: "george@example.com", + name: "George", +}; + +const signingOptions = { + draw: true, + type: true, + upload: true, + phone: false, + defaultType: "draw", +}; + +const data = { + clientId: "ec64a202072370a737edf4a0eb7f4437", + templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], + subject: "Purchase Order", + message: "Glad we could come to an agreement.", + signers: [ signer1 ], + signingOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( + signatureRequestId, + data +); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signatureRequestId** | **string**| The id of the SignatureRequest to edit. | | +| **signatureRequestEditEmbeddedWithTemplateRequest** | [**SignatureRequestEditEmbeddedWithTemplateRequest**](../model/SignatureRequestEditEmbeddedWithTemplateRequest.md)| | | + +### Return type + +[**SignatureRequestGetResponse**](../model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `signatureRequestEditWithTemplate()` + +```typescript +signatureRequestEditWithTemplate(signatureRequestId: string, signatureRequestEditWithTemplateRequest: SignatureRequestEditWithTemplateRequest): SignatureRequestGetResponse +``` + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { + role: "Client", + emailAddress: "george@example.com", + name: "George", +}; + +const cc1: DropboxSign.SubCC = { + role: "Accounting", + emailAddress: "accounting@example.com", +}; + +const customField1: DropboxSign.SubCustomField = { + name: "Cost", + value: "$20,000", + editor: "Client", + required: true, +}; + +const signingOptions: DropboxSign.SubSigningOptions = { + draw: true, + type: true, + upload: true, + phone: false, + defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, +}; + +const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { + templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], + subject: "Purchase Order", + message: "Glad we could come to an agreement.", + signers: [ signer1 ], + ccs: [ cc1 ], + customFields: [ customField1 ], + signingOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEditWithTemplate( + signatureRequestId, + data +); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const signatureRequestApi = new DropboxSign.SignatureRequestApi(); + +// Configure HTTP basic authorization: api_key +signatureRequestApi.username = "YOUR_API_KEY"; + +// or, configure Bearer (JWT) authorization: oauth2 +// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; + +const signer1 = { + role: "Client", + emailAddress: "george@example.com", + name: "George", +}; + +const cc1 = { + role: "Accounting", + emailAddress: "accounting@example.com", +}; + +const customField1 = { + name: "Cost", + value: "$20,000", + editor: "Client", + required: true, +}; + +const signingOptions = { + draw: true, + type: true, + upload: true, + phone: false, + defaultType: "draw", +}; + +const data = { + templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], + subject: "Purchase Order", + message: "Glad we could come to an agreement.", + signers: [ signer1 ], + ccs: [ cc1 ], + customFields: [ customField1 ], + signingOptions, + testMode: true, +}; + +const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +const result = signatureRequestApi.signatureRequestEditWithTemplate( + signatureRequestId, + data, +); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signatureRequestId** | **string**| The id of the SignatureRequest to edit. | | +| **signatureRequestEditWithTemplateRequest** | [**SignatureRequestEditWithTemplateRequest**](../model/SignatureRequestEditWithTemplateRequest.md)| | | + +### Return type + +[**SignatureRequestGetResponse**](../model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + ## `signatureRequestFiles()` ```typescript diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..bcc66ecf9 --- /dev/null +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,34 @@ +# # SignatureRequestEditEmbeddedRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `clientId`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | +| `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```Array```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `formFieldRules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hideTextTags` | ```boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..f417f0f72 --- /dev/null +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,25 @@ +# # SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `templateIds`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `clientId`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `customFields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditRequest.md b/sdks/node/docs/model/SignatureRequestEditRequest.md new file mode 100644 index 000000000..309384652 --- /dev/null +++ b/sdks/node/docs/model/SignatureRequestEditRequest.md @@ -0,0 +1,35 @@ +# # SignatureRequestEditRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | +| `clientId` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```Array```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `formFieldRules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hideTextTags` | ```boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `isEid` | ```boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..fdec2cfc0 --- /dev/null +++ b/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,26 @@ +# # SignatureRequestEditWithTemplateRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `templateIds`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `clientId` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `isEid` | ```boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/index.ts b/sdks/node/model/index.ts index 7813c02fc..1f2ea9c97 100644 --- a/sdks/node/model/index.ts +++ b/sdks/node/model/index.ts @@ -75,6 +75,10 @@ import { SignatureRequestBulkCreateEmbeddedWithTemplateRequest } from "./signatu import { SignatureRequestBulkSendWithTemplateRequest } from "./signatureRequestBulkSendWithTemplateRequest"; import { SignatureRequestCreateEmbeddedRequest } from "./signatureRequestCreateEmbeddedRequest"; import { SignatureRequestCreateEmbeddedWithTemplateRequest } from "./signatureRequestCreateEmbeddedWithTemplateRequest"; +import { SignatureRequestEditEmbeddedRequest } from "./signatureRequestEditEmbeddedRequest"; +import { SignatureRequestEditEmbeddedWithTemplateRequest } from "./signatureRequestEditEmbeddedWithTemplateRequest"; +import { SignatureRequestEditRequest } from "./signatureRequestEditRequest"; +import { SignatureRequestEditWithTemplateRequest } from "./signatureRequestEditWithTemplateRequest"; import { SignatureRequestGetResponse } from "./signatureRequestGetResponse"; import { SignatureRequestListResponse } from "./signatureRequestListResponse"; import { SignatureRequestRemindRequest } from "./signatureRequestRemindRequest"; @@ -315,6 +319,12 @@ export let typeMap: { [index: string]: any } = { SignatureRequestCreateEmbeddedRequest: SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest: SignatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedRequest: SignatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedWithTemplateRequest: + SignatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditRequest: SignatureRequestEditRequest, + SignatureRequestEditWithTemplateRequest: + SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse: SignatureRequestGetResponse, SignatureRequestListResponse: SignatureRequestListResponse, SignatureRequestRemindRequest: SignatureRequestRemindRequest, @@ -547,6 +557,10 @@ export { SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, + SignatureRequestEditEmbeddedRequest, + SignatureRequestEditEmbeddedWithTemplateRequest, + SignatureRequestEditRequest, + SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, diff --git a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts new file mode 100644 index 000000000..78b05c0ac --- /dev/null +++ b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts @@ -0,0 +1,264 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; +import { SubAttachment } from "./subAttachment"; +import { SubCustomField } from "./subCustomField"; +import { SubFieldOptions } from "./subFieldOptions"; +import { SubFormFieldGroup } from "./subFormFieldGroup"; +import { SubFormFieldRule } from "./subFormFieldRule"; +import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; +import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; +import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSigningOptions } from "./subSigningOptions"; + +export class SignatureRequestEditEmbeddedRequest { + /** + * Client id of the app you\'re using to create this embedded signature request. Used for security purposes. + */ + "clientId": string; + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "files"?: Array; + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "fileUrls"?: Array; + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + */ + "signers"?: Array; + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + */ + "groupedSigners"?: Array; + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + */ + "allowDecline"?: boolean = false; + /** + * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + */ + "allowReassign"?: boolean = false; + /** + * A list describing the attachments + */ + "attachments"?: Array; + /** + * The email addresses that should be CCed. + */ + "ccEmailAddresses"?: Array; + /** + * When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + */ + "customFields"?: Array; + "fieldOptions"?: SubFieldOptions; + /** + * Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + */ + "formFieldGroups"?: Array; + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + */ + "formFieldRules"?: Array; + /** + * The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + */ + "formFieldsPerDocument"?: Array; + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + */ + "hideTextTags"?: boolean = false; + /** + * The custom message in the email that will be sent to the signers. + */ + "message"?: string; + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + */ + "metadata"?: { [key: string]: any }; + "signingOptions"?: SubSigningOptions; + /** + * The subject in the email that will be sent to the signers. + */ + "subject"?: string; + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + */ + "testMode"?: boolean = false; + /** + * The title you want to assign to the SignatureRequest. + */ + "title"?: string; + /** + * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + */ + "useTextTags"?: boolean = false; + /** + * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + */ + "populateAutoFillFields"?: boolean = false; + /** + * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + */ + "expiresAt"?: number | null; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "files", + baseName: "files", + type: "Array", + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array", + }, + { + name: "signers", + baseName: "signers", + type: "Array", + }, + { + name: "groupedSigners", + baseName: "grouped_signers", + type: "Array", + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean", + }, + { + name: "allowReassign", + baseName: "allow_reassign", + type: "boolean", + }, + { + name: "attachments", + baseName: "attachments", + type: "Array", + }, + { + name: "ccEmailAddresses", + baseName: "cc_email_addresses", + type: "Array", + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array", + }, + { + name: "fieldOptions", + baseName: "field_options", + type: "SubFieldOptions", + }, + { + name: "formFieldGroups", + baseName: "form_field_groups", + type: "Array", + }, + { + name: "formFieldRules", + baseName: "form_field_rules", + type: "Array", + }, + { + name: "formFieldsPerDocument", + baseName: "form_fields_per_document", + type: "Array", + }, + { + name: "hideTextTags", + baseName: "hide_text_tags", + type: "boolean", + }, + { + name: "message", + baseName: "message", + type: "string", + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }", + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions", + }, + { + name: "subject", + baseName: "subject", + type: "string", + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + { + name: "useTextTags", + baseName: "use_text_tags", + type: "boolean", + }, + { + name: "populateAutoFillFields", + baseName: "populate_auto_fill_fields", + type: "boolean", + }, + { + name: "expiresAt", + baseName: "expires_at", + type: "number", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SignatureRequestEditEmbeddedRequest.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SignatureRequestEditEmbeddedRequest { + return ObjectSerializer.deserialize( + data, + "SignatureRequestEditEmbeddedRequest" + ); + } +} diff --git a/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts new file mode 100644 index 000000000..c007c76ca --- /dev/null +++ b/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts @@ -0,0 +1,181 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; +import { SubCC } from "./subCC"; +import { SubCustomField } from "./subCustomField"; +import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSigningOptions } from "./subSigningOptions"; + +export class SignatureRequestEditEmbeddedWithTemplateRequest { + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + */ + "templateIds": Array; + /** + * Client id of the app you\'re using to create this embedded signature request. Used for security purposes. + */ + "clientId": string; + /** + * Add Signers to your Templated-based Signature Request. + */ + "signers": Array; + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + */ + "allowDecline"?: boolean = false; + /** + * Add CC email recipients. Required when a CC role exists for the Template. + */ + "ccs"?: Array; + /** + * An array defining values and options for custom fields. Required when a custom field exists in the Template. + */ + "customFields"?: Array; + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "files"?: Array; + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "fileUrls"?: Array; + /** + * The custom message in the email that will be sent to the signers. + */ + "message"?: string; + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + */ + "metadata"?: { [key: string]: any }; + "signingOptions"?: SubSigningOptions; + /** + * The subject in the email that will be sent to the signers. + */ + "subject"?: string; + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + */ + "testMode"?: boolean = false; + /** + * The title you want to assign to the SignatureRequest. + */ + "title"?: string; + /** + * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + */ + "populateAutoFillFields"?: boolean = false; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "templateIds", + baseName: "template_ids", + type: "Array", + }, + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "signers", + baseName: "signers", + type: "Array", + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean", + }, + { + name: "ccs", + baseName: "ccs", + type: "Array", + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array", + }, + { + name: "files", + baseName: "files", + type: "Array", + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array", + }, + { + name: "message", + baseName: "message", + type: "string", + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }", + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions", + }, + { + name: "subject", + baseName: "subject", + type: "string", + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + { + name: "populateAutoFillFields", + baseName: "populate_auto_fill_fields", + type: "boolean", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SignatureRequestEditEmbeddedWithTemplateRequest.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SignatureRequestEditEmbeddedWithTemplateRequest { + return ObjectSerializer.deserialize( + data, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ); + } +} diff --git a/sdks/node/model/signatureRequestEditRequest.ts b/sdks/node/model/signatureRequestEditRequest.ts new file mode 100644 index 000000000..432e8fe4f --- /dev/null +++ b/sdks/node/model/signatureRequestEditRequest.ts @@ -0,0 +1,270 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; +import { SubAttachment } from "./subAttachment"; +import { SubCustomField } from "./subCustomField"; +import { SubFieldOptions } from "./subFieldOptions"; +import { SubFormFieldGroup } from "./subFormFieldGroup"; +import { SubFormFieldRule } from "./subFormFieldRule"; +import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; +import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; +import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSigningOptions } from "./subSigningOptions"; + +export class SignatureRequestEditRequest { + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "files"?: Array; + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "fileUrls"?: Array; + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + */ + "signers"?: Array; + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + */ + "groupedSigners"?: Array; + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + */ + "allowDecline"?: boolean = false; + /** + * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + */ + "allowReassign"?: boolean = false; + /** + * A list describing the attachments + */ + "attachments"?: Array; + /** + * The email addresses that should be CCed. + */ + "ccEmailAddresses"?: Array; + /** + * The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + */ + "clientId"?: string; + /** + * When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + */ + "customFields"?: Array; + "fieldOptions"?: SubFieldOptions; + /** + * Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + */ + "formFieldGroups"?: Array; + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + */ + "formFieldRules"?: Array; + /** + * The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + */ + "formFieldsPerDocument"?: Array; + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + */ + "hideTextTags"?: boolean = false; + /** + * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + */ + "isEid"?: boolean = false; + /** + * The custom message in the email that will be sent to the signers. + */ + "message"?: string; + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + */ + "metadata"?: { [key: string]: any }; + "signingOptions"?: SubSigningOptions; + /** + * The URL you want signers redirected to after they successfully sign. + */ + "signingRedirectUrl"?: string; + /** + * The subject in the email that will be sent to the signers. + */ + "subject"?: string; + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + */ + "testMode"?: boolean = false; + /** + * The title you want to assign to the SignatureRequest. + */ + "title"?: string; + /** + * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + */ + "useTextTags"?: boolean = false; + /** + * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + */ + "expiresAt"?: number | null; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "files", + baseName: "files", + type: "Array", + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array", + }, + { + name: "signers", + baseName: "signers", + type: "Array", + }, + { + name: "groupedSigners", + baseName: "grouped_signers", + type: "Array", + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean", + }, + { + name: "allowReassign", + baseName: "allow_reassign", + type: "boolean", + }, + { + name: "attachments", + baseName: "attachments", + type: "Array", + }, + { + name: "ccEmailAddresses", + baseName: "cc_email_addresses", + type: "Array", + }, + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array", + }, + { + name: "fieldOptions", + baseName: "field_options", + type: "SubFieldOptions", + }, + { + name: "formFieldGroups", + baseName: "form_field_groups", + type: "Array", + }, + { + name: "formFieldRules", + baseName: "form_field_rules", + type: "Array", + }, + { + name: "formFieldsPerDocument", + baseName: "form_fields_per_document", + type: "Array", + }, + { + name: "hideTextTags", + baseName: "hide_text_tags", + type: "boolean", + }, + { + name: "isEid", + baseName: "is_eid", + type: "boolean", + }, + { + name: "message", + baseName: "message", + type: "string", + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }", + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions", + }, + { + name: "signingRedirectUrl", + baseName: "signing_redirect_url", + type: "string", + }, + { + name: "subject", + baseName: "subject", + type: "string", + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + { + name: "useTextTags", + baseName: "use_text_tags", + type: "boolean", + }, + { + name: "expiresAt", + baseName: "expires_at", + type: "number", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SignatureRequestEditRequest.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SignatureRequestEditRequest { + return ObjectSerializer.deserialize(data, "SignatureRequestEditRequest"); + } +} diff --git a/sdks/node/model/signatureRequestEditWithTemplateRequest.ts b/sdks/node/model/signatureRequestEditWithTemplateRequest.ts new file mode 100644 index 000000000..f35af5999 --- /dev/null +++ b/sdks/node/model/signatureRequestEditWithTemplateRequest.ts @@ -0,0 +1,193 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; +import { SubCC } from "./subCC"; +import { SubCustomField } from "./subCustomField"; +import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSigningOptions } from "./subSigningOptions"; + +/** + * + */ +export class SignatureRequestEditWithTemplateRequest { + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + */ + "templateIds": Array; + /** + * Add Signers to your Templated-based Signature Request. + */ + "signers": Array; + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + */ + "allowDecline"?: boolean = false; + /** + * Add CC email recipients. Required when a CC role exists for the Template. + */ + "ccs"?: Array; + /** + * Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + */ + "clientId"?: string; + /** + * An array defining values and options for custom fields. Required when a custom field exists in the Template. + */ + "customFields"?: Array; + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "files"?: Array; + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + */ + "fileUrls"?: Array; + /** + * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + */ + "isEid"?: boolean = false; + /** + * The custom message in the email that will be sent to the signers. + */ + "message"?: string; + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + */ + "metadata"?: { [key: string]: any }; + "signingOptions"?: SubSigningOptions; + /** + * The URL you want signers redirected to after they successfully sign. + */ + "signingRedirectUrl"?: string; + /** + * The subject in the email that will be sent to the signers. + */ + "subject"?: string; + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + */ + "testMode"?: boolean = false; + /** + * The title you want to assign to the SignatureRequest. + */ + "title"?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "templateIds", + baseName: "template_ids", + type: "Array", + }, + { + name: "signers", + baseName: "signers", + type: "Array", + }, + { + name: "allowDecline", + baseName: "allow_decline", + type: "boolean", + }, + { + name: "ccs", + baseName: "ccs", + type: "Array", + }, + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "customFields", + baseName: "custom_fields", + type: "Array", + }, + { + name: "files", + baseName: "files", + type: "Array", + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array", + }, + { + name: "isEid", + baseName: "is_eid", + type: "boolean", + }, + { + name: "message", + baseName: "message", + type: "string", + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }", + }, + { + name: "signingOptions", + baseName: "signing_options", + type: "SubSigningOptions", + }, + { + name: "signingRedirectUrl", + baseName: "signing_redirect_url", + type: "string", + }, + { + name: "subject", + baseName: "subject", + type: "string", + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SignatureRequestEditWithTemplateRequest.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SignatureRequestEditWithTemplateRequest { + return ObjectSerializer.deserialize( + data, + "SignatureRequestEditWithTemplateRequest" + ); + } +} diff --git a/sdks/node/types/api/signatureRequestApi.d.ts b/sdks/node/types/api/signatureRequestApi.d.ts index 58a02bdcd..54c21ae91 100644 --- a/sdks/node/types/api/signatureRequestApi.d.ts +++ b/sdks/node/types/api/signatureRequestApi.d.ts @@ -1,4 +1,4 @@ -import { Authentication, BulkSendJobSendResponse, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest } from "../model"; +import { Authentication, BulkSendJobSendResponse, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestEditEmbeddedRequest, SignatureRequestEditEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest } from "../model"; import { optionsI, returnTypeI, returnTypeT } from "./"; export declare enum SignatureRequestApiApiKeys { } @@ -29,6 +29,10 @@ export declare class SignatureRequestApi { signatureRequestCancel(signatureRequestId: string, options?: optionsI): Promise; signatureRequestCreateEmbedded(signatureRequestCreateEmbeddedRequest: SignatureRequestCreateEmbeddedRequest, options?: optionsI): Promise>; signatureRequestCreateEmbeddedWithTemplate(signatureRequestCreateEmbeddedWithTemplateRequest: SignatureRequestCreateEmbeddedWithTemplateRequest, options?: optionsI): Promise>; + signatureRequestEdit(signatureRequestId: string, signatureRequestEditRequest: SignatureRequestEditRequest, options?: optionsI): Promise>; + signatureRequestEditEmbedded(signatureRequestId: string, signatureRequestEditEmbeddedRequest: SignatureRequestEditEmbeddedRequest, options?: optionsI): Promise>; + signatureRequestEditEmbeddedWithTemplate(signatureRequestId: string, signatureRequestEditEmbeddedWithTemplateRequest: SignatureRequestEditEmbeddedWithTemplateRequest, options?: optionsI): Promise>; + signatureRequestEditWithTemplate(signatureRequestId: string, signatureRequestEditWithTemplateRequest: SignatureRequestEditWithTemplateRequest, options?: optionsI): Promise>; signatureRequestFiles(signatureRequestId: string, fileType?: "pdf" | "zip", options?: optionsI): Promise>; signatureRequestFilesAsDataUri(signatureRequestId: string, options?: optionsI): Promise>; signatureRequestFilesAsFileUrl(signatureRequestId: string, forceDownload?: number, options?: optionsI): Promise>; diff --git a/sdks/node/types/model/index.d.ts b/sdks/node/types/model/index.d.ts index 664b47950..99010c62f 100644 --- a/sdks/node/types/model/index.d.ts +++ b/sdks/node/types/model/index.d.ts @@ -63,6 +63,10 @@ import { SignatureRequestBulkCreateEmbeddedWithTemplateRequest } from "./signatu import { SignatureRequestBulkSendWithTemplateRequest } from "./signatureRequestBulkSendWithTemplateRequest"; import { SignatureRequestCreateEmbeddedRequest } from "./signatureRequestCreateEmbeddedRequest"; import { SignatureRequestCreateEmbeddedWithTemplateRequest } from "./signatureRequestCreateEmbeddedWithTemplateRequest"; +import { SignatureRequestEditEmbeddedRequest } from "./signatureRequestEditEmbeddedRequest"; +import { SignatureRequestEditEmbeddedWithTemplateRequest } from "./signatureRequestEditEmbeddedWithTemplateRequest"; +import { SignatureRequestEditRequest } from "./signatureRequestEditRequest"; +import { SignatureRequestEditWithTemplateRequest } from "./signatureRequestEditWithTemplateRequest"; import { SignatureRequestGetResponse } from "./signatureRequestGetResponse"; import { SignatureRequestListResponse } from "./signatureRequestListResponse"; import { SignatureRequestRemindRequest } from "./signatureRequestRemindRequest"; @@ -194,4 +198,4 @@ export declare let enumsMap: { export declare let typeMap: { [index: string]: any; }; -export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FaxListResponse, FaxResponse, FaxResponseTransmission, FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; +export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FaxListResponse, FaxResponse, FaxResponseTransmission, FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestEditEmbeddedRequest, SignatureRequestEditEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; diff --git a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts new file mode 100644 index 000000000..6c2691435 --- /dev/null +++ b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts @@ -0,0 +1,42 @@ +import { AttributeTypeMap, RequestFile } from "./"; +import { SubAttachment } from "./subAttachment"; +import { SubCustomField } from "./subCustomField"; +import { SubFieldOptions } from "./subFieldOptions"; +import { SubFormFieldGroup } from "./subFormFieldGroup"; +import { SubFormFieldRule } from "./subFormFieldRule"; +import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; +import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; +import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSigningOptions } from "./subSigningOptions"; +export declare class SignatureRequestEditEmbeddedRequest { + "clientId": string; + "files"?: Array; + "fileUrls"?: Array; + "signers"?: Array; + "groupedSigners"?: Array; + "allowDecline"?: boolean; + "allowReassign"?: boolean; + "attachments"?: Array; + "ccEmailAddresses"?: Array; + "customFields"?: Array; + "fieldOptions"?: SubFieldOptions; + "formFieldGroups"?: Array; + "formFieldRules"?: Array; + "formFieldsPerDocument"?: Array; + "hideTextTags"?: boolean; + "message"?: string; + "metadata"?: { + [key: string]: any; + }; + "signingOptions"?: SubSigningOptions; + "subject"?: string; + "testMode"?: boolean; + "title"?: string; + "useTextTags"?: boolean; + "populateAutoFillFields"?: boolean; + "expiresAt"?: number | null; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SignatureRequestEditEmbeddedRequest; +} diff --git a/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts new file mode 100644 index 000000000..6824ad17f --- /dev/null +++ b/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts @@ -0,0 +1,28 @@ +import { AttributeTypeMap, RequestFile } from "./"; +import { SubCC } from "./subCC"; +import { SubCustomField } from "./subCustomField"; +import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSigningOptions } from "./subSigningOptions"; +export declare class SignatureRequestEditEmbeddedWithTemplateRequest { + "templateIds": Array; + "clientId": string; + "signers": Array; + "allowDecline"?: boolean; + "ccs"?: Array; + "customFields"?: Array; + "files"?: Array; + "fileUrls"?: Array; + "message"?: string; + "metadata"?: { + [key: string]: any; + }; + "signingOptions"?: SubSigningOptions; + "subject"?: string; + "testMode"?: boolean; + "title"?: string; + "populateAutoFillFields"?: boolean; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SignatureRequestEditEmbeddedWithTemplateRequest; +} diff --git a/sdks/node/types/model/signatureRequestEditRequest.d.ts b/sdks/node/types/model/signatureRequestEditRequest.d.ts new file mode 100644 index 000000000..91a01f76c --- /dev/null +++ b/sdks/node/types/model/signatureRequestEditRequest.d.ts @@ -0,0 +1,43 @@ +import { AttributeTypeMap, RequestFile } from "./"; +import { SubAttachment } from "./subAttachment"; +import { SubCustomField } from "./subCustomField"; +import { SubFieldOptions } from "./subFieldOptions"; +import { SubFormFieldGroup } from "./subFormFieldGroup"; +import { SubFormFieldRule } from "./subFormFieldRule"; +import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; +import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; +import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSigningOptions } from "./subSigningOptions"; +export declare class SignatureRequestEditRequest { + "files"?: Array; + "fileUrls"?: Array; + "signers"?: Array; + "groupedSigners"?: Array; + "allowDecline"?: boolean; + "allowReassign"?: boolean; + "attachments"?: Array; + "ccEmailAddresses"?: Array; + "clientId"?: string; + "customFields"?: Array; + "fieldOptions"?: SubFieldOptions; + "formFieldGroups"?: Array; + "formFieldRules"?: Array; + "formFieldsPerDocument"?: Array; + "hideTextTags"?: boolean; + "isEid"?: boolean; + "message"?: string; + "metadata"?: { + [key: string]: any; + }; + "signingOptions"?: SubSigningOptions; + "signingRedirectUrl"?: string; + "subject"?: string; + "testMode"?: boolean; + "title"?: string; + "useTextTags"?: boolean; + "expiresAt"?: number | null; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SignatureRequestEditRequest; +} diff --git a/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts new file mode 100644 index 000000000..5dc2d730a --- /dev/null +++ b/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts @@ -0,0 +1,29 @@ +import { AttributeTypeMap, RequestFile } from "./"; +import { SubCC } from "./subCC"; +import { SubCustomField } from "./subCustomField"; +import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSigningOptions } from "./subSigningOptions"; +export declare class SignatureRequestEditWithTemplateRequest { + "templateIds": Array; + "signers": Array; + "allowDecline"?: boolean; + "ccs"?: Array; + "clientId"?: string; + "customFields"?: Array; + "files"?: Array; + "fileUrls"?: Array; + "isEid"?: boolean; + "message"?: string; + "metadata"?: { + [key: string]: any; + }; + "signingOptions"?: SubSigningOptions; + "signingRedirectUrl"?: string; + "subject"?: string; + "testMode"?: boolean; + "title"?: string; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SignatureRequestEditWithTemplateRequest; +} diff --git a/sdks/php/README.md b/sdks/php/README.md index 946c74e1f..c2c3feb33 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -180,6 +180,10 @@ All URIs are relative to *https://api.hellosign.com/v3* | *SignatureRequestApi* | [**signatureRequestCancel**](docs/Api/SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | | *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](docs/Api/SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | | *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](docs/Api/SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +| *SignatureRequestApi* | [**signatureRequestEdit**](docs/Api/SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +| *SignatureRequestApi* | [**signatureRequestEditEmbedded**](docs/Api/SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +| *SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](docs/Api/SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +| *SignatureRequestApi* | [**signatureRequestEditWithTemplate**](docs/Api/SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | | *SignatureRequestApi* | [**signatureRequestFiles**](docs/Api/SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files | | *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](docs/Api/SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | | *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](docs/Api/SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -283,6 +287,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SignatureRequestBulkSendWithTemplateRequest](docs/Model/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](docs/Model/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md) +- [SignatureRequestEditEmbeddedRequest](docs/Model/SignatureRequestEditEmbeddedRequest.md) +- [SignatureRequestEditEmbeddedWithTemplateRequest](docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md) +- [SignatureRequestEditRequest](docs/Model/SignatureRequestEditRequest.md) +- [SignatureRequestEditWithTemplateRequest](docs/Model/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](docs/Model/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](docs/Model/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](docs/Model/SignatureRequestRemindRequest.md) diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index aa4979035..7fa0c8108 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to https://api.hellosign.com/v3. | [**signatureRequestCancel()**](SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | | [**signatureRequestCreateEmbedded()**](SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | | [**signatureRequestCreateEmbeddedWithTemplate()**](SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +| [**signatureRequestEdit()**](SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +| [**signatureRequestEditEmbedded()**](SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +| [**signatureRequestEditEmbeddedWithTemplate()**](SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +| [**signatureRequestEditWithTemplate()**](SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | | [**signatureRequestFiles()**](SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files | | [**signatureRequestFilesAsDataUri()**](SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | | [**signatureRequestFilesAsFileUrl()**](SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -453,6 +457,386 @@ try { [[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `signatureRequestEdit()` + +```php +signatureRequestEdit($signature_request_id, $signature_request_edit_request): \Dropbox\Sign\Model\SignatureRequestGetResponse +``` +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +```php +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer1->setEmailAddress("jack@example.com") + ->setName("Jack") + ->setOrder(0); + +$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer2->setEmailAddress("jill@example.com") + ->setName("Jill") + ->setOrder(1); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); +$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$data = new Dropbox\Sign\Model\SignatureRequestEditRequest(); +$data->setTitle("NDA with Acme Co.") + ->setSubject("The NDA we talked about") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + ->setSigners([$signer1, $signer2]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setMetadata([ + "custom_id" => 1234, + "custom_text" => "NDA #9", + ]) + ->setSigningOptions($signingOptions) + ->setFieldOptions($fieldOptions) + ->setTestMode(true); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestEdit($signatureRequestId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signature_request_id** | **string**| The id of the SignatureRequest to edit. | | +| **signature_request_edit_request** | [**\Dropbox\Sign\Model\SignatureRequestEditRequest**](../Model/SignatureRequestEditRequest.md)| | | + +### Return type + +[**\Dropbox\Sign\Model\SignatureRequestGetResponse**](../Model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `signatureRequestEditEmbedded()` + +```php +signatureRequestEditEmbedded($signature_request_id, $signature_request_edit_embedded_request): \Dropbox\Sign\Model\SignatureRequestGetResponse +``` +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +```php +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer1->setEmailAddress("jack@example.com") + ->setName("Jack") + ->setOrder(0); + +$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); +$signer2->setEmailAddress("jill@example.com") + ->setName("Jill") + ->setOrder(1); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(true) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setTitle("NDA with Acme Co.") + ->setSubject("The NDA we talked about") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") + ->setSigners([$signer1, $signer2]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setSigningOptions($signingOptions) + ->setTestMode(true); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestEditEmbedded( + $signatureRequestId, + $data + ); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signature_request_id** | **string**| The id of the SignatureRequest to edit. | | +| **signature_request_edit_embedded_request** | [**\Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest**](../Model/SignatureRequestEditEmbeddedRequest.md)| | | + +### Return type + +[**\Dropbox\Sign\Model\SignatureRequestGetResponse**](../Model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `signatureRequestEditEmbeddedWithTemplate()` + +```php +signatureRequestEditEmbeddedWithTemplate($signature_request_id, $signature_request_edit_embedded_with_template_request): \Dropbox\Sign\Model\SignatureRequestGetResponse +``` +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +```php +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signer1->setRole("Client") + ->setEmailAddress("george@example.com") + ->setName("George"); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest(); +$data->setClientId("ec64a202072370a737edf4a0eb7f4437") + ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) + ->setSubject("Purchase Order") + ->setMessage("Glad we could come to an agreement.") + ->setSigners([$signer1]) + ->setSigningOptions($signingOptions) + ->setTestMode(true); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestEditEmbeddedWithTemplate( + $signatureRequestId, + $data + ); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signature_request_id** | **string**| The id of the SignatureRequest to edit. | | +| **signature_request_edit_embedded_with_template_request** | [**\Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest**](../Model/SignatureRequestEditEmbeddedWithTemplateRequest.md)| | | + +### Return type + +[**\Dropbox\Sign\Model\SignatureRequestGetResponse**](../Model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `signatureRequestEditWithTemplate()` + +```php +signatureRequestEditWithTemplate($signature_request_id, $signature_request_edit_with_template_request): \Dropbox\Sign\Model\SignatureRequestGetResponse +``` +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +```php +setUsername("YOUR_API_KEY"); + +// or, configure Bearer (JWT) authorization: oauth2 +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); + +$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); +$signer1->setRole("Client") + ->setEmailAddress("george@example.com") + ->setName("George"); + +$cc1 = new Dropbox\Sign\Model\SubCC(); +$cc1->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$customField1 = new Dropbox\Sign\Model\SubCustomField(); +$customField1->setName("Cost") + ->setValue("$20,000") + ->setEditor("Client") + ->setRequired(true); + +$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); +$signingOptions->setDraw(true) + ->setType(true) + ->setUpload(true) + ->setPhone(false) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); + +$data = new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest(); +$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) + ->setSubject("Purchase Order") + ->setMessage("Glad we could come to an agreement.") + ->setSigners([$signer1]) + ->setCcs([$cc1]) + ->setCustomFields([$customField1]) + ->setSigningOptions($signingOptions) + ->setTestMode(true); + +$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + +try { + $result = $signatureRequestApi->signatureRequestEditWithTemplate($signatureRequestId, $data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **signature_request_id** | **string**| The id of the SignatureRequest to edit. | | +| **signature_request_edit_with_template_request** | [**\Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest**](../Model/SignatureRequestEditWithTemplateRequest.md)| | | + +### Return type + +[**\Dropbox\Sign\Model\SignatureRequestGetResponse**](../Model/SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + ## `signatureRequestFiles()` ```php diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..b2567ac3f --- /dev/null +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,34 @@ +# # SignatureRequestEditEmbeddedRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..3b9df4cac --- /dev/null +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,25 @@ +# # SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditRequest.md b/sdks/php/docs/Model/SignatureRequestEditRequest.md new file mode 100644 index 000000000..0d3ca23ce --- /dev/null +++ b/sdks/php/docs/Model/SignatureRequestEditRequest.md @@ -0,0 +1,35 @@ +# # SignatureRequestEditRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | +| `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```\Dropbox\Sign\Model\SubFormFieldGroup[]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..072fdc080 --- /dev/null +++ b/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,26 @@ +# # SignatureRequestEditWithTemplateRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```string``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```string``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```string``` | The title you want to assign to the SignatureRequest. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Api/SignatureRequestApi.php b/sdks/php/src/Api/SignatureRequestApi.php index e8da69d75..38947f821 100644 --- a/sdks/php/src/Api/SignatureRequestApi.php +++ b/sdks/php/src/Api/SignatureRequestApi.php @@ -87,6 +87,22 @@ class SignatureRequestApi 'application/json', 'multipart/form-data', ], + 'signatureRequestEdit' => [ + 'application/json', + 'multipart/form-data', + ], + 'signatureRequestEditEmbedded' => [ + 'application/json', + 'multipart/form-data', + ], + 'signatureRequestEditEmbeddedWithTemplate' => [ + 'application/json', + 'multipart/form-data', + ], + 'signatureRequestEditWithTemplate' => [ + 'application/json', + 'multipart/form-data', + ], 'signatureRequestFiles' => [ 'application/json', ], @@ -1776,6 +1792,1446 @@ public function signatureRequestCreateEmbeddedWithTemplateRequest(Model\Signatur ); } + /** + * Operation signatureRequestEdit + * + * Edit Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditRequest $signature_request_edit_request signature_request_edit_request (required) + * + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function signatureRequestEdit(string $signature_request_id, Model\SignatureRequestEditRequest $signature_request_edit_request) + { + list($response) = $this->signatureRequestEditWithHttpInfo($signature_request_id, $signature_request_edit_request); + return $response; + } + + /** + * Operation signatureRequestEditWithHttpInfo + * + * Edit Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation + * + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEdit. This method will eventually become unavailable + */ + public function signatureRequestEditWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditRequest $signature_request_edit_request, string $contentType = self::contentTypes['signatureRequestEdit'][0]) + { + $request = $this->signatureRequestEditRequest($signature_request_id, $signature_request_edit_request, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\SignatureRequestGetResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation signatureRequestEditAsync + * + * Edit Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEdit. This method will eventually become unavailable + */ + public function signatureRequestEditAsync(string $signature_request_id, Model\SignatureRequestEditRequest $signature_request_edit_request, string $contentType = self::contentTypes['signatureRequestEdit'][0]) + { + return $this->signatureRequestEditAsyncWithHttpInfo($signature_request_id, $signature_request_edit_request, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation signatureRequestEditAsyncWithHttpInfo + * + * Edit Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEdit. This method will eventually become unavailable + */ + public function signatureRequestEditAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditRequest $signature_request_edit_request, string $contentType = self::contentTypes['signatureRequestEdit'][0]) + { + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + $request = $this->signatureRequestEditRequest($signature_request_id, $signature_request_edit_request, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'signatureRequestEdit' + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditRequest $signature_request_edit_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEdit'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEdit. This method will eventually become unavailable + */ + public function signatureRequestEditRequest(string $signature_request_id, Model\SignatureRequestEditRequest $signature_request_edit_request, string $contentType = self::contentTypes['signatureRequestEdit'][0]) + { + // verify the required parameter 'signature_request_id' is set + if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_id when calling signatureRequestEdit' + ); + } + + // verify the required parameter 'signature_request_edit_request' is set + if ($signature_request_edit_request === null || (is_array($signature_request_edit_request) && count($signature_request_edit_request) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_edit_request when calling signatureRequestEdit' + ); + } + + $resourcePath = '/signature_request/edit/{signature_request_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + $formParams = ObjectSerializer::getFormParams( + $signature_request_edit_request + ); + + $multipart = !empty($formParams); + + // path params + if ($signature_request_id !== null) { + $resourcePath = str_replace( + '{signature_request_id}', + ObjectSerializer::toPathValue($signature_request_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) === 0) { + if (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the body + $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_edit_request)); + } else { + $httpBody = $signature_request_edit_request; + } + } elseif (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + if ($payloadHook = $this->config->getPayloadHook()) { + $payloadHook('multipart', $multipartContents, $signature_request_edit_request); + } + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + // this endpoint requires Bearer (JWT) authentication (access token) + if (!empty($this->config->getAccessToken())) { + $headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken(); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'PUT', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation signatureRequestEditEmbedded + * + * Edit Embedded Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request signature_request_edit_embedded_request (required) + * + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function signatureRequestEditEmbedded(string $signature_request_id, Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request) + { + list($response) = $this->signatureRequestEditEmbeddedWithHttpInfo($signature_request_id, $signature_request_edit_embedded_request); + return $response; + } + + /** + * Operation signatureRequestEditEmbeddedWithHttpInfo + * + * Edit Embedded Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation + * + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbedded. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request, string $contentType = self::contentTypes['signatureRequestEditEmbedded'][0]) + { + $request = $this->signatureRequestEditEmbeddedRequest($signature_request_id, $signature_request_edit_embedded_request, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\SignatureRequestGetResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation signatureRequestEditEmbeddedAsync + * + * Edit Embedded Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbedded. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedAsync(string $signature_request_id, Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request, string $contentType = self::contentTypes['signatureRequestEditEmbedded'][0]) + { + return $this->signatureRequestEditEmbeddedAsyncWithHttpInfo($signature_request_id, $signature_request_edit_embedded_request, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation signatureRequestEditEmbeddedAsyncWithHttpInfo + * + * Edit Embedded Signature Request + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbedded. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request, string $contentType = self::contentTypes['signatureRequestEditEmbedded'][0]) + { + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + $request = $this->signatureRequestEditEmbeddedRequest($signature_request_id, $signature_request_edit_embedded_request, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'signatureRequestEditEmbedded' + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbedded'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbedded. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedRequest(string $signature_request_id, Model\SignatureRequestEditEmbeddedRequest $signature_request_edit_embedded_request, string $contentType = self::contentTypes['signatureRequestEditEmbedded'][0]) + { + // verify the required parameter 'signature_request_id' is set + if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_id when calling signatureRequestEditEmbedded' + ); + } + + // verify the required parameter 'signature_request_edit_embedded_request' is set + if ($signature_request_edit_embedded_request === null || (is_array($signature_request_edit_embedded_request) && count($signature_request_edit_embedded_request) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_edit_embedded_request when calling signatureRequestEditEmbedded' + ); + } + + $resourcePath = '/signature_request/edit_embedded/{signature_request_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + $formParams = ObjectSerializer::getFormParams( + $signature_request_edit_embedded_request + ); + + $multipart = !empty($formParams); + + // path params + if ($signature_request_id !== null) { + $resourcePath = str_replace( + '{signature_request_id}', + ObjectSerializer::toPathValue($signature_request_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) === 0) { + if (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the body + $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_edit_embedded_request)); + } else { + $httpBody = $signature_request_edit_embedded_request; + } + } elseif (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + if ($payloadHook = $this->config->getPayloadHook()) { + $payloadHook('multipart', $multipartContents, $signature_request_edit_embedded_request); + } + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + // this endpoint requires Bearer (JWT) authentication (access token) + if (!empty($this->config->getAccessToken())) { + $headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken(); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'PUT', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation signatureRequestEditEmbeddedWithTemplate + * + * Edit Embedded Signature Request with Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request signature_request_edit_embedded_with_template_request (required) + * + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function signatureRequestEditEmbeddedWithTemplate(string $signature_request_id, Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request) + { + list($response) = $this->signatureRequestEditEmbeddedWithTemplateWithHttpInfo($signature_request_id, $signature_request_edit_embedded_with_template_request); + return $response; + } + + /** + * Operation signatureRequestEditEmbeddedWithTemplateWithHttpInfo + * + * Edit Embedded Signature Request with Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation + * + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbeddedWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedWithTemplateWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestEditEmbeddedWithTemplate'][0]) + { + $request = $this->signatureRequestEditEmbeddedWithTemplateRequest($signature_request_id, $signature_request_edit_embedded_with_template_request, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\SignatureRequestGetResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation signatureRequestEditEmbeddedWithTemplateAsync + * + * Edit Embedded Signature Request with Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbeddedWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedWithTemplateAsync(string $signature_request_id, Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestEditEmbeddedWithTemplate'][0]) + { + return $this->signatureRequestEditEmbeddedWithTemplateAsyncWithHttpInfo($signature_request_id, $signature_request_edit_embedded_with_template_request, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation signatureRequestEditEmbeddedWithTemplateAsyncWithHttpInfo + * + * Edit Embedded Signature Request with Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbeddedWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedWithTemplateAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestEditEmbeddedWithTemplate'][0]) + { + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + $request = $this->signatureRequestEditEmbeddedWithTemplateRequest($signature_request_id, $signature_request_edit_embedded_with_template_request, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'signatureRequestEditEmbeddedWithTemplate' + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditEmbeddedWithTemplate'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditEmbeddedWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditEmbeddedWithTemplateRequest(string $signature_request_id, Model\SignatureRequestEditEmbeddedWithTemplateRequest $signature_request_edit_embedded_with_template_request, string $contentType = self::contentTypes['signatureRequestEditEmbeddedWithTemplate'][0]) + { + // verify the required parameter 'signature_request_id' is set + if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_id when calling signatureRequestEditEmbeddedWithTemplate' + ); + } + + // verify the required parameter 'signature_request_edit_embedded_with_template_request' is set + if ($signature_request_edit_embedded_with_template_request === null || (is_array($signature_request_edit_embedded_with_template_request) && count($signature_request_edit_embedded_with_template_request) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_edit_embedded_with_template_request when calling signatureRequestEditEmbeddedWithTemplate' + ); + } + + $resourcePath = '/signature_request/edit_embedded_with_template/{signature_request_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + $formParams = ObjectSerializer::getFormParams( + $signature_request_edit_embedded_with_template_request + ); + + $multipart = !empty($formParams); + + // path params + if ($signature_request_id !== null) { + $resourcePath = str_replace( + '{signature_request_id}', + ObjectSerializer::toPathValue($signature_request_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) === 0) { + if (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the body + $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_edit_embedded_with_template_request)); + } else { + $httpBody = $signature_request_edit_embedded_with_template_request; + } + } elseif (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + if ($payloadHook = $this->config->getPayloadHook()) { + $payloadHook('multipart', $multipartContents, $signature_request_edit_embedded_with_template_request); + } + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + // this endpoint requires Bearer (JWT) authentication (access token) + if (!empty($this->config->getAccessToken())) { + $headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken(); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'PUT', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation signatureRequestEditWithTemplate + * + * Edit Signature Request With Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request signature_request_edit_with_template_request (required) + * + * @return Model\SignatureRequestGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function signatureRequestEditWithTemplate(string $signature_request_id, Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request) + { + list($response) = $this->signatureRequestEditWithTemplateWithHttpInfo($signature_request_id, $signature_request_edit_with_template_request); + return $response; + } + + /** + * Operation signatureRequestEditWithTemplateWithHttpInfo + * + * Edit Signature Request With Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation + * + * @return array of Model\SignatureRequestGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditWithTemplateWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request, string $contentType = self::contentTypes['signatureRequestEditWithTemplate'][0]) + { + $request = $this->signatureRequestEditWithTemplateRequest($signature_request_id, $signature_request_edit_with_template_request, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\SignatureRequestGetResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\SignatureRequestGetResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\SignatureRequestGetResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation signatureRequestEditWithTemplateAsync + * + * Edit Signature Request With Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditWithTemplateAsync(string $signature_request_id, Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request, string $contentType = self::contentTypes['signatureRequestEditWithTemplate'][0]) + { + return $this->signatureRequestEditWithTemplateAsyncWithHttpInfo($signature_request_id, $signature_request_edit_with_template_request, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation signatureRequestEditWithTemplateAsyncWithHttpInfo + * + * Edit Signature Request With Template + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditWithTemplateAsyncWithHttpInfo(string $signature_request_id, Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request, string $contentType = self::contentTypes['signatureRequestEditWithTemplate'][0]) + { + $returnType = '\Dropbox\Sign\Model\SignatureRequestGetResponse'; + $request = $this->signatureRequestEditWithTemplateRequest($signature_request_id, $signature_request_edit_with_template_request, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'signatureRequestEditWithTemplate' + * + * @param string $signature_request_id The id of the SignatureRequest to edit. (required) + * @param Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['signatureRequestEditWithTemplate'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::signatureRequestEditWithTemplate. This method will eventually become unavailable + */ + public function signatureRequestEditWithTemplateRequest(string $signature_request_id, Model\SignatureRequestEditWithTemplateRequest $signature_request_edit_with_template_request, string $contentType = self::contentTypes['signatureRequestEditWithTemplate'][0]) + { + // verify the required parameter 'signature_request_id' is set + if ($signature_request_id === null || (is_array($signature_request_id) && count($signature_request_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_id when calling signatureRequestEditWithTemplate' + ); + } + + // verify the required parameter 'signature_request_edit_with_template_request' is set + if ($signature_request_edit_with_template_request === null || (is_array($signature_request_edit_with_template_request) && count($signature_request_edit_with_template_request) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $signature_request_edit_with_template_request when calling signatureRequestEditWithTemplate' + ); + } + + $resourcePath = '/signature_request/edit_with_template/{signature_request_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + $formParams = ObjectSerializer::getFormParams( + $signature_request_edit_with_template_request + ); + + $multipart = !empty($formParams); + + // path params + if ($signature_request_id !== null) { + $resourcePath = str_replace( + '{signature_request_id}', + ObjectSerializer::toPathValue($signature_request_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) === 0) { + if (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the body + $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($signature_request_edit_with_template_request)); + } else { + $httpBody = $signature_request_edit_with_template_request; + } + } elseif (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + if ($payloadHook = $this->config->getPayloadHook()) { + $payloadHook('multipart', $multipartContents, $signature_request_edit_with_template_request); + } + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + // this endpoint requires Bearer (JWT) authentication (access token) + if (!empty($this->config->getAccessToken())) { + $headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken(); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'PUT', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + /** * Operation signatureRequestFiles * diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php new file mode 100644 index 000000000..fcc387bc3 --- /dev/null +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php @@ -0,0 +1,1231 @@ + + */ +class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SignatureRequestEditEmbeddedRequest'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'client_id' => 'string', + 'files' => '\SplFileObject[]', + 'file_urls' => 'string[]', + 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', + 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', + 'allow_decline' => 'bool', + 'allow_reassign' => 'bool', + 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', + 'cc_email_addresses' => 'string[]', + 'custom_fields' => '\Dropbox\Sign\Model\SubCustomField[]', + 'field_options' => '\Dropbox\Sign\Model\SubFieldOptions', + 'form_field_groups' => '\Dropbox\Sign\Model\SubFormFieldGroup[]', + 'form_field_rules' => '\Dropbox\Sign\Model\SubFormFieldRule[]', + 'form_fields_per_document' => '\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]', + 'hide_text_tags' => 'bool', + 'message' => 'string', + 'metadata' => 'array', + 'signing_options' => '\Dropbox\Sign\Model\SubSigningOptions', + 'subject' => 'string', + 'test_mode' => 'bool', + 'title' => 'string', + 'use_text_tags' => 'bool', + 'populate_auto_fill_fields' => 'bool', + 'expires_at' => 'int', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'client_id' => null, + 'files' => 'binary', + 'file_urls' => null, + 'signers' => null, + 'grouped_signers' => null, + 'allow_decline' => null, + 'allow_reassign' => null, + 'attachments' => null, + 'cc_email_addresses' => 'email', + 'custom_fields' => null, + 'field_options' => null, + 'form_field_groups' => null, + 'form_field_rules' => null, + 'form_fields_per_document' => null, + 'hide_text_tags' => null, + 'message' => null, + 'metadata' => null, + 'signing_options' => null, + 'subject' => null, + 'test_mode' => null, + 'title' => null, + 'use_text_tags' => null, + 'populate_auto_fill_fields' => null, + 'expires_at' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'client_id' => false, + 'files' => false, + 'file_urls' => false, + 'signers' => false, + 'grouped_signers' => false, + 'allow_decline' => false, + 'allow_reassign' => false, + 'attachments' => false, + 'cc_email_addresses' => false, + 'custom_fields' => false, + 'field_options' => false, + 'form_field_groups' => false, + 'form_field_rules' => false, + 'form_fields_per_document' => false, + 'hide_text_tags' => false, + 'message' => false, + 'metadata' => false, + 'signing_options' => false, + 'subject' => false, + 'test_mode' => false, + 'title' => false, + 'use_text_tags' => false, + 'populate_auto_fill_fields' => false, + 'expires_at' => true, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'client_id' => 'client_id', + 'files' => 'files', + 'file_urls' => 'file_urls', + 'signers' => 'signers', + 'grouped_signers' => 'grouped_signers', + 'allow_decline' => 'allow_decline', + 'allow_reassign' => 'allow_reassign', + 'attachments' => 'attachments', + 'cc_email_addresses' => 'cc_email_addresses', + 'custom_fields' => 'custom_fields', + 'field_options' => 'field_options', + 'form_field_groups' => 'form_field_groups', + 'form_field_rules' => 'form_field_rules', + 'form_fields_per_document' => 'form_fields_per_document', + 'hide_text_tags' => 'hide_text_tags', + 'message' => 'message', + 'metadata' => 'metadata', + 'signing_options' => 'signing_options', + 'subject' => 'subject', + 'test_mode' => 'test_mode', + 'title' => 'title', + 'use_text_tags' => 'use_text_tags', + 'populate_auto_fill_fields' => 'populate_auto_fill_fields', + 'expires_at' => 'expires_at', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'client_id' => 'setClientId', + 'files' => 'setFiles', + 'file_urls' => 'setFileUrls', + 'signers' => 'setSigners', + 'grouped_signers' => 'setGroupedSigners', + 'allow_decline' => 'setAllowDecline', + 'allow_reassign' => 'setAllowReassign', + 'attachments' => 'setAttachments', + 'cc_email_addresses' => 'setCcEmailAddresses', + 'custom_fields' => 'setCustomFields', + 'field_options' => 'setFieldOptions', + 'form_field_groups' => 'setFormFieldGroups', + 'form_field_rules' => 'setFormFieldRules', + 'form_fields_per_document' => 'setFormFieldsPerDocument', + 'hide_text_tags' => 'setHideTextTags', + 'message' => 'setMessage', + 'metadata' => 'setMetadata', + 'signing_options' => 'setSigningOptions', + 'subject' => 'setSubject', + 'test_mode' => 'setTestMode', + 'title' => 'setTitle', + 'use_text_tags' => 'setUseTextTags', + 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', + 'expires_at' => 'setExpiresAt', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'client_id' => 'getClientId', + 'files' => 'getFiles', + 'file_urls' => 'getFileUrls', + 'signers' => 'getSigners', + 'grouped_signers' => 'getGroupedSigners', + 'allow_decline' => 'getAllowDecline', + 'allow_reassign' => 'getAllowReassign', + 'attachments' => 'getAttachments', + 'cc_email_addresses' => 'getCcEmailAddresses', + 'custom_fields' => 'getCustomFields', + 'field_options' => 'getFieldOptions', + 'form_field_groups' => 'getFormFieldGroups', + 'form_field_rules' => 'getFormFieldRules', + 'form_fields_per_document' => 'getFormFieldsPerDocument', + 'hide_text_tags' => 'getHideTextTags', + 'message' => 'getMessage', + 'metadata' => 'getMetadata', + 'signing_options' => 'getSigningOptions', + 'subject' => 'getSubject', + 'test_mode' => 'getTestMode', + 'title' => 'getTitle', + 'use_text_tags' => 'getUseTextTags', + 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', + 'expires_at' => 'getExpiresAt', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('client_id', $data ?? [], null); + $this->setIfExists('files', $data ?? [], null); + $this->setIfExists('file_urls', $data ?? [], null); + $this->setIfExists('signers', $data ?? [], null); + $this->setIfExists('grouped_signers', $data ?? [], null); + $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_reassign', $data ?? [], false); + $this->setIfExists('attachments', $data ?? [], null); + $this->setIfExists('cc_email_addresses', $data ?? [], null); + $this->setIfExists('custom_fields', $data ?? [], null); + $this->setIfExists('field_options', $data ?? [], null); + $this->setIfExists('form_field_groups', $data ?? [], null); + $this->setIfExists('form_field_rules', $data ?? [], null); + $this->setIfExists('form_fields_per_document', $data ?? [], null); + $this->setIfExists('hide_text_tags', $data ?? [], false); + $this->setIfExists('message', $data ?? [], null); + $this->setIfExists('metadata', $data ?? [], null); + $this->setIfExists('signing_options', $data ?? [], null); + $this->setIfExists('subject', $data ?? [], null); + $this->setIfExists('test_mode', $data ?? [], false); + $this->setIfExists('title', $data ?? [], null); + $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); + $this->setIfExists('expires_at', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): SignatureRequestEditEmbeddedRequest + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): SignatureRequestEditEmbeddedRequest + { + /** @var SignatureRequestEditEmbeddedRequest */ + return ObjectSerializer::deserialize( + $data, + SignatureRequestEditEmbeddedRequest::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['client_id'] === null) { + $invalidProperties[] = "'client_id' can't be null"; + } + if (!is_null($this->container['message']) && (mb_strlen($this->container['message']) > 5000)) { + $invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000."; + } + + if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 255)) { + $invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 255."; + } + + if (!is_null($this->container['title']) && (mb_strlen($this->container['title']) > 255)) { + $invalidProperties[] = "invalid value for 'title', the character length must be smaller than or equal to 255."; + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets client_id + * + * @return string + */ + public function getClientId() + { + return $this->container['client_id']; + } + + /** + * Sets client_id + * + * @param string $client_id Client id of the app you're using to create this embedded signature request. Used for security purposes. + * + * @return self + */ + public function setClientId(string $client_id) + { + if (is_null($client_id)) { + throw new InvalidArgumentException('non-nullable client_id cannot be null'); + } + $this->container['client_id'] = $client_id; + + return $this; + } + + /** + * Gets files + * + * @return SplFileObject[]|null + */ + public function getFiles() + { + return $this->container['files']; + } + + /** + * Sets files + * + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFiles(?array $files) + { + if (is_null($files)) { + throw new InvalidArgumentException('non-nullable files cannot be null'); + } + $this->container['files'] = $files; + + return $this; + } + + /** + * Gets file_urls + * + * @return string[]|null + */ + public function getFileUrls() + { + return $this->container['file_urls']; + } + + /** + * Sets file_urls + * + * @param string[]|null $file_urls Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFileUrls(?array $file_urls) + { + if (is_null($file_urls)) { + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + } + $this->container['file_urls'] = $file_urls; + + return $this; + } + + /** + * Gets signers + * + * @return SubSignatureRequestSigner[]|null + */ + public function getSigners() + { + return $this->container['signers']; + } + + /** + * Sets signers + * + * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * + * @return self + */ + public function setSigners(?array $signers) + { + if (is_null($signers)) { + throw new InvalidArgumentException('non-nullable signers cannot be null'); + } + $this->container['signers'] = $signers; + + return $this; + } + + /** + * Gets grouped_signers + * + * @return SubSignatureRequestGroupedSigners[]|null + */ + public function getGroupedSigners() + { + return $this->container['grouped_signers']; + } + + /** + * Sets grouped_signers + * + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * + * @return self + */ + public function setGroupedSigners(?array $grouped_signers) + { + if (is_null($grouped_signers)) { + throw new InvalidArgumentException('non-nullable grouped_signers cannot be null'); + } + $this->container['grouped_signers'] = $grouped_signers; + + return $this; + } + + /** + * Gets allow_decline + * + * @return bool|null + */ + public function getAllowDecline() + { + return $this->container['allow_decline']; + } + + /** + * Sets allow_decline + * + * @param bool|null $allow_decline Allows signers to decline to sign a document if `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowDecline(?bool $allow_decline) + { + if (is_null($allow_decline)) { + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + } + $this->container['allow_decline'] = $allow_decline; + + return $this; + } + + /** + * Gets allow_reassign + * + * @return bool|null + */ + public function getAllowReassign() + { + return $this->container['allow_reassign']; + } + + /** + * Sets allow_reassign + * + * @param bool|null $allow_reassign Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + * + * @return self + */ + public function setAllowReassign(?bool $allow_reassign) + { + if (is_null($allow_reassign)) { + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + } + $this->container['allow_reassign'] = $allow_reassign; + + return $this; + } + + /** + * Gets attachments + * + * @return SubAttachment[]|null + */ + public function getAttachments() + { + return $this->container['attachments']; + } + + /** + * Sets attachments + * + * @param SubAttachment[]|null $attachments A list describing the attachments + * + * @return self + */ + public function setAttachments(?array $attachments) + { + if (is_null($attachments)) { + throw new InvalidArgumentException('non-nullable attachments cannot be null'); + } + $this->container['attachments'] = $attachments; + + return $this; + } + + /** + * Gets cc_email_addresses + * + * @return string[]|null + */ + public function getCcEmailAddresses() + { + return $this->container['cc_email_addresses']; + } + + /** + * Sets cc_email_addresses + * + * @param string[]|null $cc_email_addresses the email addresses that should be CCed + * + * @return self + */ + public function setCcEmailAddresses(?array $cc_email_addresses) + { + if (is_null($cc_email_addresses)) { + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + } + $this->container['cc_email_addresses'] = $cc_email_addresses; + + return $this; + } + + /** + * Gets custom_fields + * + * @return SubCustomField[]|null + */ + public function getCustomFields() + { + return $this->container['custom_fields']; + } + + /** + * Sets custom_fields + * + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * + * @return self + */ + public function setCustomFields(?array $custom_fields) + { + if (is_null($custom_fields)) { + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + } + $this->container['custom_fields'] = $custom_fields; + + return $this; + } + + /** + * Gets field_options + * + * @return SubFieldOptions|null + */ + public function getFieldOptions() + { + return $this->container['field_options']; + } + + /** + * Sets field_options + * + * @param SubFieldOptions|null $field_options field_options + * + * @return self + */ + public function setFieldOptions(?SubFieldOptions $field_options) + { + if (is_null($field_options)) { + throw new InvalidArgumentException('non-nullable field_options cannot be null'); + } + $this->container['field_options'] = $field_options; + + return $this; + } + + /** + * Gets form_field_groups + * + * @return SubFormFieldGroup[]|null + */ + public function getFormFieldGroups() + { + return $this->container['form_field_groups']; + } + + /** + * Sets form_field_groups + * + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * + * @return self + */ + public function setFormFieldGroups(?array $form_field_groups) + { + if (is_null($form_field_groups)) { + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + } + $this->container['form_field_groups'] = $form_field_groups; + + return $this; + } + + /** + * Gets form_field_rules + * + * @return SubFormFieldRule[]|null + */ + public function getFormFieldRules() + { + return $this->container['form_field_rules']; + } + + /** + * Sets form_field_rules + * + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * + * @return self + */ + public function setFormFieldRules(?array $form_field_rules) + { + if (is_null($form_field_rules)) { + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + } + $this->container['form_field_rules'] = $form_field_rules; + + return $this; + } + + /** + * Gets form_fields_per_document + * + * @return SubFormFieldsPerDocumentBase[]|null + */ + public function getFormFieldsPerDocument() + { + return $this->container['form_fields_per_document']; + } + + /** + * Sets form_fields_per_document + * + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * + * @return self + */ + public function setFormFieldsPerDocument(?array $form_fields_per_document) + { + if (is_null($form_fields_per_document)) { + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + } + $this->container['form_fields_per_document'] = $form_fields_per_document; + + return $this; + } + + /** + * Gets hide_text_tags + * + * @return bool|null + */ + public function getHideTextTags() + { + return $this->container['hide_text_tags']; + } + + /** + * Sets hide_text_tags + * + * @param bool|null $hide_text_tags Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + * + * @return self + */ + public function setHideTextTags(?bool $hide_text_tags) + { + if (is_null($hide_text_tags)) { + throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + } + $this->container['hide_text_tags'] = $hide_text_tags; + + return $this; + } + + /** + * Gets message + * + * @return string|null + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * + * @param string|null $message the custom message in the email that will be sent to the signers + * + * @return self + */ + public function setMessage(?string $message) + { + if (is_null($message)) { + throw new InvalidArgumentException('non-nullable message cannot be null'); + } + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestEditEmbeddedRequest., must be smaller than or equal to 5000.'); + } + + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets metadata + * + * @return array|null + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * + * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return self + */ + public function setMetadata(?array $metadata) + { + if (is_null($metadata)) { + throw new InvalidArgumentException('non-nullable metadata cannot be null'); + } + + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets signing_options + * + * @return SubSigningOptions|null + */ + public function getSigningOptions() + { + return $this->container['signing_options']; + } + + /** + * Sets signing_options + * + * @param SubSigningOptions|null $signing_options signing_options + * + * @return self + */ + public function setSigningOptions(?SubSigningOptions $signing_options) + { + if (is_null($signing_options)) { + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + } + $this->container['signing_options'] = $signing_options; + + return $this; + } + + /** + * Gets subject + * + * @return string|null + */ + public function getSubject() + { + return $this->container['subject']; + } + + /** + * Sets subject + * + * @param string|null $subject the subject in the email that will be sent to the signers + * + * @return self + */ + public function setSubject(?string $subject) + { + if (is_null($subject)) { + throw new InvalidArgumentException('non-nullable subject cannot be null'); + } + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestEditEmbeddedRequest., must be smaller than or equal to 255.'); + } + + $this->container['subject'] = $subject; + + return $this; + } + + /** + * Gets test_mode + * + * @return bool|null + */ + public function getTestMode() + { + return $this->container['test_mode']; + } + + /** + * Sets test_mode + * + * @param bool|null $test_mode Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setTestMode(?bool $test_mode) + { + if (is_null($test_mode)) { + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + } + $this->container['test_mode'] = $test_mode; + + return $this; + } + + /** + * Gets title + * + * @return string|null + */ + public function getTitle() + { + return $this->container['title']; + } + + /** + * Sets title + * + * @param string|null $title the title you want to assign to the SignatureRequest + * + * @return self + */ + public function setTitle(?string $title) + { + if (is_null($title)) { + throw new InvalidArgumentException('non-nullable title cannot be null'); + } + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestEditEmbeddedRequest., must be smaller than or equal to 255.'); + } + + $this->container['title'] = $title; + + return $this; + } + + /** + * Gets use_text_tags + * + * @return bool|null + */ + public function getUseTextTags() + { + return $this->container['use_text_tags']; + } + + /** + * Sets use_text_tags + * + * @param bool|null $use_text_tags Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + * + * @return self + */ + public function setUseTextTags(?bool $use_text_tags) + { + if (is_null($use_text_tags)) { + throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); + } + $this->container['use_text_tags'] = $use_text_tags; + + return $this; + } + + /** + * Gets populate_auto_fill_fields + * + * @return bool|null + */ + public function getPopulateAutoFillFields() + { + return $this->container['populate_auto_fill_fields']; + } + + /** + * Sets populate_auto_fill_fields + * + * @param bool|null $populate_auto_fill_fields Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + * + * @return self + */ + public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) + { + if (is_null($populate_auto_fill_fields)) { + throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + } + $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; + + return $this; + } + + /** + * Gets expires_at + * + * @return int|null + */ + public function getExpiresAt() + { + return $this->container['expires_at']; + } + + /** + * Sets expires_at + * + * @param int|null $expires_at When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * + * @return self + */ + public function setExpiresAt(?int $expires_at) + { + if (is_null($expires_at)) { + array_push($this->openAPINullablesSetToNull, 'expires_at'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('expires_at', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['expires_at'] = $expires_at; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php new file mode 100644 index 000000000..07d174a7a --- /dev/null +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php @@ -0,0 +1,924 @@ + + */ +class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SignatureRequestEditEmbeddedWithTemplateRequest'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'template_ids' => 'string[]', + 'client_id' => 'string', + 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]', + 'allow_decline' => 'bool', + 'ccs' => '\Dropbox\Sign\Model\SubCC[]', + 'custom_fields' => '\Dropbox\Sign\Model\SubCustomField[]', + 'files' => '\SplFileObject[]', + 'file_urls' => 'string[]', + 'message' => 'string', + 'metadata' => 'array', + 'signing_options' => '\Dropbox\Sign\Model\SubSigningOptions', + 'subject' => 'string', + 'test_mode' => 'bool', + 'title' => 'string', + 'populate_auto_fill_fields' => 'bool', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'template_ids' => null, + 'client_id' => null, + 'signers' => null, + 'allow_decline' => null, + 'ccs' => null, + 'custom_fields' => null, + 'files' => 'binary', + 'file_urls' => null, + 'message' => null, + 'metadata' => null, + 'signing_options' => null, + 'subject' => null, + 'test_mode' => null, + 'title' => null, + 'populate_auto_fill_fields' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'template_ids' => false, + 'client_id' => false, + 'signers' => false, + 'allow_decline' => false, + 'ccs' => false, + 'custom_fields' => false, + 'files' => false, + 'file_urls' => false, + 'message' => false, + 'metadata' => false, + 'signing_options' => false, + 'subject' => false, + 'test_mode' => false, + 'title' => false, + 'populate_auto_fill_fields' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'template_ids' => 'template_ids', + 'client_id' => 'client_id', + 'signers' => 'signers', + 'allow_decline' => 'allow_decline', + 'ccs' => 'ccs', + 'custom_fields' => 'custom_fields', + 'files' => 'files', + 'file_urls' => 'file_urls', + 'message' => 'message', + 'metadata' => 'metadata', + 'signing_options' => 'signing_options', + 'subject' => 'subject', + 'test_mode' => 'test_mode', + 'title' => 'title', + 'populate_auto_fill_fields' => 'populate_auto_fill_fields', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'template_ids' => 'setTemplateIds', + 'client_id' => 'setClientId', + 'signers' => 'setSigners', + 'allow_decline' => 'setAllowDecline', + 'ccs' => 'setCcs', + 'custom_fields' => 'setCustomFields', + 'files' => 'setFiles', + 'file_urls' => 'setFileUrls', + 'message' => 'setMessage', + 'metadata' => 'setMetadata', + 'signing_options' => 'setSigningOptions', + 'subject' => 'setSubject', + 'test_mode' => 'setTestMode', + 'title' => 'setTitle', + 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'template_ids' => 'getTemplateIds', + 'client_id' => 'getClientId', + 'signers' => 'getSigners', + 'allow_decline' => 'getAllowDecline', + 'ccs' => 'getCcs', + 'custom_fields' => 'getCustomFields', + 'files' => 'getFiles', + 'file_urls' => 'getFileUrls', + 'message' => 'getMessage', + 'metadata' => 'getMetadata', + 'signing_options' => 'getSigningOptions', + 'subject' => 'getSubject', + 'test_mode' => 'getTestMode', + 'title' => 'getTitle', + 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('template_ids', $data ?? [], null); + $this->setIfExists('client_id', $data ?? [], null); + $this->setIfExists('signers', $data ?? [], null); + $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('ccs', $data ?? [], null); + $this->setIfExists('custom_fields', $data ?? [], null); + $this->setIfExists('files', $data ?? [], null); + $this->setIfExists('file_urls', $data ?? [], null); + $this->setIfExists('message', $data ?? [], null); + $this->setIfExists('metadata', $data ?? [], null); + $this->setIfExists('signing_options', $data ?? [], null); + $this->setIfExists('subject', $data ?? [], null); + $this->setIfExists('test_mode', $data ?? [], false); + $this->setIfExists('title', $data ?? [], null); + $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): SignatureRequestEditEmbeddedWithTemplateRequest + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): SignatureRequestEditEmbeddedWithTemplateRequest + { + /** @var SignatureRequestEditEmbeddedWithTemplateRequest */ + return ObjectSerializer::deserialize( + $data, + SignatureRequestEditEmbeddedWithTemplateRequest::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['template_ids'] === null) { + $invalidProperties[] = "'template_ids' can't be null"; + } + if ($this->container['client_id'] === null) { + $invalidProperties[] = "'client_id' can't be null"; + } + if ($this->container['signers'] === null) { + $invalidProperties[] = "'signers' can't be null"; + } + if (!is_null($this->container['message']) && (mb_strlen($this->container['message']) > 5000)) { + $invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000."; + } + + if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 255)) { + $invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 255."; + } + + if (!is_null($this->container['title']) && (mb_strlen($this->container['title']) > 255)) { + $invalidProperties[] = "invalid value for 'title', the character length must be smaller than or equal to 255."; + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets template_ids + * + * @return string[] + */ + public function getTemplateIds() + { + return $this->container['template_ids']; + } + + /** + * Sets template_ids + * + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used + * + * @return self + */ + public function setTemplateIds(array $template_ids) + { + if (is_null($template_ids)) { + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + } + $this->container['template_ids'] = $template_ids; + + return $this; + } + + /** + * Gets client_id + * + * @return string + */ + public function getClientId() + { + return $this->container['client_id']; + } + + /** + * Sets client_id + * + * @param string $client_id Client id of the app you're using to create this embedded signature request. Used for security purposes. + * + * @return self + */ + public function setClientId(string $client_id) + { + if (is_null($client_id)) { + throw new InvalidArgumentException('non-nullable client_id cannot be null'); + } + $this->container['client_id'] = $client_id; + + return $this; + } + + /** + * Gets signers + * + * @return SubSignatureRequestTemplateSigner[] + */ + public function getSigners() + { + return $this->container['signers']; + } + + /** + * Sets signers + * + * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * + * @return self + */ + public function setSigners(array $signers) + { + if (is_null($signers)) { + throw new InvalidArgumentException('non-nullable signers cannot be null'); + } + $this->container['signers'] = $signers; + + return $this; + } + + /** + * Gets allow_decline + * + * @return bool|null + */ + public function getAllowDecline() + { + return $this->container['allow_decline']; + } + + /** + * Sets allow_decline + * + * @param bool|null $allow_decline Allows signers to decline to sign a document if `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowDecline(?bool $allow_decline) + { + if (is_null($allow_decline)) { + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + } + $this->container['allow_decline'] = $allow_decline; + + return $this; + } + + /** + * Gets ccs + * + * @return SubCC[]|null + */ + public function getCcs() + { + return $this->container['ccs']; + } + + /** + * Sets ccs + * + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * + * @return self + */ + public function setCcs(?array $ccs) + { + if (is_null($ccs)) { + throw new InvalidArgumentException('non-nullable ccs cannot be null'); + } + $this->container['ccs'] = $ccs; + + return $this; + } + + /** + * Gets custom_fields + * + * @return SubCustomField[]|null + */ + public function getCustomFields() + { + return $this->container['custom_fields']; + } + + /** + * Sets custom_fields + * + * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * + * @return self + */ + public function setCustomFields(?array $custom_fields) + { + if (is_null($custom_fields)) { + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + } + $this->container['custom_fields'] = $custom_fields; + + return $this; + } + + /** + * Gets files + * + * @return SplFileObject[]|null + */ + public function getFiles() + { + return $this->container['files']; + } + + /** + * Sets files + * + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFiles(?array $files) + { + if (is_null($files)) { + throw new InvalidArgumentException('non-nullable files cannot be null'); + } + $this->container['files'] = $files; + + return $this; + } + + /** + * Gets file_urls + * + * @return string[]|null + */ + public function getFileUrls() + { + return $this->container['file_urls']; + } + + /** + * Sets file_urls + * + * @param string[]|null $file_urls Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFileUrls(?array $file_urls) + { + if (is_null($file_urls)) { + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + } + $this->container['file_urls'] = $file_urls; + + return $this; + } + + /** + * Gets message + * + * @return string|null + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * + * @param string|null $message the custom message in the email that will be sent to the signers + * + * @return self + */ + public function setMessage(?string $message) + { + if (is_null($message)) { + throw new InvalidArgumentException('non-nullable message cannot be null'); + } + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestEditEmbeddedWithTemplateRequest., must be smaller than or equal to 5000.'); + } + + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets metadata + * + * @return array|null + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * + * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return self + */ + public function setMetadata(?array $metadata) + { + if (is_null($metadata)) { + throw new InvalidArgumentException('non-nullable metadata cannot be null'); + } + + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets signing_options + * + * @return SubSigningOptions|null + */ + public function getSigningOptions() + { + return $this->container['signing_options']; + } + + /** + * Sets signing_options + * + * @param SubSigningOptions|null $signing_options signing_options + * + * @return self + */ + public function setSigningOptions(?SubSigningOptions $signing_options) + { + if (is_null($signing_options)) { + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + } + $this->container['signing_options'] = $signing_options; + + return $this; + } + + /** + * Gets subject + * + * @return string|null + */ + public function getSubject() + { + return $this->container['subject']; + } + + /** + * Sets subject + * + * @param string|null $subject the subject in the email that will be sent to the signers + * + * @return self + */ + public function setSubject(?string $subject) + { + if (is_null($subject)) { + throw new InvalidArgumentException('non-nullable subject cannot be null'); + } + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestEditEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + } + + $this->container['subject'] = $subject; + + return $this; + } + + /** + * Gets test_mode + * + * @return bool|null + */ + public function getTestMode() + { + return $this->container['test_mode']; + } + + /** + * Sets test_mode + * + * @param bool|null $test_mode Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setTestMode(?bool $test_mode) + { + if (is_null($test_mode)) { + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + } + $this->container['test_mode'] = $test_mode; + + return $this; + } + + /** + * Gets title + * + * @return string|null + */ + public function getTitle() + { + return $this->container['title']; + } + + /** + * Sets title + * + * @param string|null $title the title you want to assign to the SignatureRequest + * + * @return self + */ + public function setTitle(?string $title) + { + if (is_null($title)) { + throw new InvalidArgumentException('non-nullable title cannot be null'); + } + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestEditEmbeddedWithTemplateRequest., must be smaller than or equal to 255.'); + } + + $this->container['title'] = $title; + + return $this; + } + + /** + * Gets populate_auto_fill_fields + * + * @return bool|null + */ + public function getPopulateAutoFillFields() + { + return $this->container['populate_auto_fill_fields']; + } + + /** + * Sets populate_auto_fill_fields + * + * @param bool|null $populate_auto_fill_fields Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + * + * @return self + */ + public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) + { + if (is_null($populate_auto_fill_fields)) { + throw new InvalidArgumentException('non-nullable populate_auto_fill_fields cannot be null'); + } + $this->container['populate_auto_fill_fields'] = $populate_auto_fill_fields; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/SignatureRequestEditRequest.php b/sdks/php/src/Model/SignatureRequestEditRequest.php new file mode 100644 index 000000000..bc1be125a --- /dev/null +++ b/sdks/php/src/Model/SignatureRequestEditRequest.php @@ -0,0 +1,1262 @@ + + */ +class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SignatureRequestEditRequest'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'files' => '\SplFileObject[]', + 'file_urls' => 'string[]', + 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', + 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', + 'allow_decline' => 'bool', + 'allow_reassign' => 'bool', + 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', + 'cc_email_addresses' => 'string[]', + 'client_id' => 'string', + 'custom_fields' => '\Dropbox\Sign\Model\SubCustomField[]', + 'field_options' => '\Dropbox\Sign\Model\SubFieldOptions', + 'form_field_groups' => '\Dropbox\Sign\Model\SubFormFieldGroup[]', + 'form_field_rules' => '\Dropbox\Sign\Model\SubFormFieldRule[]', + 'form_fields_per_document' => '\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]', + 'hide_text_tags' => 'bool', + 'is_eid' => 'bool', + 'message' => 'string', + 'metadata' => 'array', + 'signing_options' => '\Dropbox\Sign\Model\SubSigningOptions', + 'signing_redirect_url' => 'string', + 'subject' => 'string', + 'test_mode' => 'bool', + 'title' => 'string', + 'use_text_tags' => 'bool', + 'expires_at' => 'int', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'files' => 'binary', + 'file_urls' => null, + 'signers' => null, + 'grouped_signers' => null, + 'allow_decline' => null, + 'allow_reassign' => null, + 'attachments' => null, + 'cc_email_addresses' => 'email', + 'client_id' => null, + 'custom_fields' => null, + 'field_options' => null, + 'form_field_groups' => null, + 'form_field_rules' => null, + 'form_fields_per_document' => null, + 'hide_text_tags' => null, + 'is_eid' => null, + 'message' => null, + 'metadata' => null, + 'signing_options' => null, + 'signing_redirect_url' => null, + 'subject' => null, + 'test_mode' => null, + 'title' => null, + 'use_text_tags' => null, + 'expires_at' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'files' => false, + 'file_urls' => false, + 'signers' => false, + 'grouped_signers' => false, + 'allow_decline' => false, + 'allow_reassign' => false, + 'attachments' => false, + 'cc_email_addresses' => false, + 'client_id' => false, + 'custom_fields' => false, + 'field_options' => false, + 'form_field_groups' => false, + 'form_field_rules' => false, + 'form_fields_per_document' => false, + 'hide_text_tags' => false, + 'is_eid' => false, + 'message' => false, + 'metadata' => false, + 'signing_options' => false, + 'signing_redirect_url' => false, + 'subject' => false, + 'test_mode' => false, + 'title' => false, + 'use_text_tags' => false, + 'expires_at' => true, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'files' => 'files', + 'file_urls' => 'file_urls', + 'signers' => 'signers', + 'grouped_signers' => 'grouped_signers', + 'allow_decline' => 'allow_decline', + 'allow_reassign' => 'allow_reassign', + 'attachments' => 'attachments', + 'cc_email_addresses' => 'cc_email_addresses', + 'client_id' => 'client_id', + 'custom_fields' => 'custom_fields', + 'field_options' => 'field_options', + 'form_field_groups' => 'form_field_groups', + 'form_field_rules' => 'form_field_rules', + 'form_fields_per_document' => 'form_fields_per_document', + 'hide_text_tags' => 'hide_text_tags', + 'is_eid' => 'is_eid', + 'message' => 'message', + 'metadata' => 'metadata', + 'signing_options' => 'signing_options', + 'signing_redirect_url' => 'signing_redirect_url', + 'subject' => 'subject', + 'test_mode' => 'test_mode', + 'title' => 'title', + 'use_text_tags' => 'use_text_tags', + 'expires_at' => 'expires_at', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'files' => 'setFiles', + 'file_urls' => 'setFileUrls', + 'signers' => 'setSigners', + 'grouped_signers' => 'setGroupedSigners', + 'allow_decline' => 'setAllowDecline', + 'allow_reassign' => 'setAllowReassign', + 'attachments' => 'setAttachments', + 'cc_email_addresses' => 'setCcEmailAddresses', + 'client_id' => 'setClientId', + 'custom_fields' => 'setCustomFields', + 'field_options' => 'setFieldOptions', + 'form_field_groups' => 'setFormFieldGroups', + 'form_field_rules' => 'setFormFieldRules', + 'form_fields_per_document' => 'setFormFieldsPerDocument', + 'hide_text_tags' => 'setHideTextTags', + 'is_eid' => 'setIsEid', + 'message' => 'setMessage', + 'metadata' => 'setMetadata', + 'signing_options' => 'setSigningOptions', + 'signing_redirect_url' => 'setSigningRedirectUrl', + 'subject' => 'setSubject', + 'test_mode' => 'setTestMode', + 'title' => 'setTitle', + 'use_text_tags' => 'setUseTextTags', + 'expires_at' => 'setExpiresAt', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'files' => 'getFiles', + 'file_urls' => 'getFileUrls', + 'signers' => 'getSigners', + 'grouped_signers' => 'getGroupedSigners', + 'allow_decline' => 'getAllowDecline', + 'allow_reassign' => 'getAllowReassign', + 'attachments' => 'getAttachments', + 'cc_email_addresses' => 'getCcEmailAddresses', + 'client_id' => 'getClientId', + 'custom_fields' => 'getCustomFields', + 'field_options' => 'getFieldOptions', + 'form_field_groups' => 'getFormFieldGroups', + 'form_field_rules' => 'getFormFieldRules', + 'form_fields_per_document' => 'getFormFieldsPerDocument', + 'hide_text_tags' => 'getHideTextTags', + 'is_eid' => 'getIsEid', + 'message' => 'getMessage', + 'metadata' => 'getMetadata', + 'signing_options' => 'getSigningOptions', + 'signing_redirect_url' => 'getSigningRedirectUrl', + 'subject' => 'getSubject', + 'test_mode' => 'getTestMode', + 'title' => 'getTitle', + 'use_text_tags' => 'getUseTextTags', + 'expires_at' => 'getExpiresAt', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('files', $data ?? [], null); + $this->setIfExists('file_urls', $data ?? [], null); + $this->setIfExists('signers', $data ?? [], null); + $this->setIfExists('grouped_signers', $data ?? [], null); + $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_reassign', $data ?? [], false); + $this->setIfExists('attachments', $data ?? [], null); + $this->setIfExists('cc_email_addresses', $data ?? [], null); + $this->setIfExists('client_id', $data ?? [], null); + $this->setIfExists('custom_fields', $data ?? [], null); + $this->setIfExists('field_options', $data ?? [], null); + $this->setIfExists('form_field_groups', $data ?? [], null); + $this->setIfExists('form_field_rules', $data ?? [], null); + $this->setIfExists('form_fields_per_document', $data ?? [], null); + $this->setIfExists('hide_text_tags', $data ?? [], false); + $this->setIfExists('is_eid', $data ?? [], false); + $this->setIfExists('message', $data ?? [], null); + $this->setIfExists('metadata', $data ?? [], null); + $this->setIfExists('signing_options', $data ?? [], null); + $this->setIfExists('signing_redirect_url', $data ?? [], null); + $this->setIfExists('subject', $data ?? [], null); + $this->setIfExists('test_mode', $data ?? [], false); + $this->setIfExists('title', $data ?? [], null); + $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('expires_at', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): SignatureRequestEditRequest + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): SignatureRequestEditRequest + { + /** @var SignatureRequestEditRequest */ + return ObjectSerializer::deserialize( + $data, + SignatureRequestEditRequest::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if (!is_null($this->container['message']) && (mb_strlen($this->container['message']) > 5000)) { + $invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000."; + } + + if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 255)) { + $invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 255."; + } + + if (!is_null($this->container['title']) && (mb_strlen($this->container['title']) > 255)) { + $invalidProperties[] = "invalid value for 'title', the character length must be smaller than or equal to 255."; + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets files + * + * @return SplFileObject[]|null + */ + public function getFiles() + { + return $this->container['files']; + } + + /** + * Sets files + * + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFiles(?array $files) + { + if (is_null($files)) { + throw new InvalidArgumentException('non-nullable files cannot be null'); + } + $this->container['files'] = $files; + + return $this; + } + + /** + * Gets file_urls + * + * @return string[]|null + */ + public function getFileUrls() + { + return $this->container['file_urls']; + } + + /** + * Sets file_urls + * + * @param string[]|null $file_urls Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFileUrls(?array $file_urls) + { + if (is_null($file_urls)) { + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + } + $this->container['file_urls'] = $file_urls; + + return $this; + } + + /** + * Gets signers + * + * @return SubSignatureRequestSigner[]|null + */ + public function getSigners() + { + return $this->container['signers']; + } + + /** + * Sets signers + * + * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * + * @return self + */ + public function setSigners(?array $signers) + { + if (is_null($signers)) { + throw new InvalidArgumentException('non-nullable signers cannot be null'); + } + $this->container['signers'] = $signers; + + return $this; + } + + /** + * Gets grouped_signers + * + * @return SubSignatureRequestGroupedSigners[]|null + */ + public function getGroupedSigners() + { + return $this->container['grouped_signers']; + } + + /** + * Sets grouped_signers + * + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * + * @return self + */ + public function setGroupedSigners(?array $grouped_signers) + { + if (is_null($grouped_signers)) { + throw new InvalidArgumentException('non-nullable grouped_signers cannot be null'); + } + $this->container['grouped_signers'] = $grouped_signers; + + return $this; + } + + /** + * Gets allow_decline + * + * @return bool|null + */ + public function getAllowDecline() + { + return $this->container['allow_decline']; + } + + /** + * Sets allow_decline + * + * @param bool|null $allow_decline Allows signers to decline to sign a document if `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowDecline(?bool $allow_decline) + { + if (is_null($allow_decline)) { + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + } + $this->container['allow_decline'] = $allow_decline; + + return $this; + } + + /** + * Gets allow_reassign + * + * @return bool|null + */ + public function getAllowReassign() + { + return $this->container['allow_reassign']; + } + + /** + * Sets allow_reassign + * + * @param bool|null $allow_reassign Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + * + * @return self + */ + public function setAllowReassign(?bool $allow_reassign) + { + if (is_null($allow_reassign)) { + throw new InvalidArgumentException('non-nullable allow_reassign cannot be null'); + } + $this->container['allow_reassign'] = $allow_reassign; + + return $this; + } + + /** + * Gets attachments + * + * @return SubAttachment[]|null + */ + public function getAttachments() + { + return $this->container['attachments']; + } + + /** + * Sets attachments + * + * @param SubAttachment[]|null $attachments A list describing the attachments + * + * @return self + */ + public function setAttachments(?array $attachments) + { + if (is_null($attachments)) { + throw new InvalidArgumentException('non-nullable attachments cannot be null'); + } + $this->container['attachments'] = $attachments; + + return $this; + } + + /** + * Gets cc_email_addresses + * + * @return string[]|null + */ + public function getCcEmailAddresses() + { + return $this->container['cc_email_addresses']; + } + + /** + * Sets cc_email_addresses + * + * @param string[]|null $cc_email_addresses the email addresses that should be CCed + * + * @return self + */ + public function setCcEmailAddresses(?array $cc_email_addresses) + { + if (is_null($cc_email_addresses)) { + throw new InvalidArgumentException('non-nullable cc_email_addresses cannot be null'); + } + $this->container['cc_email_addresses'] = $cc_email_addresses; + + return $this; + } + + /** + * Gets client_id + * + * @return string|null + */ + public function getClientId() + { + return $this->container['client_id']; + } + + /** + * Sets client_id + * + * @param string|null $client_id The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + * + * @return self + */ + public function setClientId(?string $client_id) + { + if (is_null($client_id)) { + throw new InvalidArgumentException('non-nullable client_id cannot be null'); + } + $this->container['client_id'] = $client_id; + + return $this; + } + + /** + * Gets custom_fields + * + * @return SubCustomField[]|null + */ + public function getCustomFields() + { + return $this->container['custom_fields']; + } + + /** + * Sets custom_fields + * + * @param SubCustomField[]|null $custom_fields When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * + * @return self + */ + public function setCustomFields(?array $custom_fields) + { + if (is_null($custom_fields)) { + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + } + $this->container['custom_fields'] = $custom_fields; + + return $this; + } + + /** + * Gets field_options + * + * @return SubFieldOptions|null + */ + public function getFieldOptions() + { + return $this->container['field_options']; + } + + /** + * Sets field_options + * + * @param SubFieldOptions|null $field_options field_options + * + * @return self + */ + public function setFieldOptions(?SubFieldOptions $field_options) + { + if (is_null($field_options)) { + throw new InvalidArgumentException('non-nullable field_options cannot be null'); + } + $this->container['field_options'] = $field_options; + + return $this; + } + + /** + * Gets form_field_groups + * + * @return SubFormFieldGroup[]|null + */ + public function getFormFieldGroups() + { + return $this->container['form_field_groups']; + } + + /** + * Sets form_field_groups + * + * @param SubFormFieldGroup[]|null $form_field_groups Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + * + * @return self + */ + public function setFormFieldGroups(?array $form_field_groups) + { + if (is_null($form_field_groups)) { + throw new InvalidArgumentException('non-nullable form_field_groups cannot be null'); + } + $this->container['form_field_groups'] = $form_field_groups; + + return $this; + } + + /** + * Gets form_field_rules + * + * @return SubFormFieldRule[]|null + */ + public function getFormFieldRules() + { + return $this->container['form_field_rules']; + } + + /** + * Sets form_field_rules + * + * @param SubFormFieldRule[]|null $form_field_rules conditional Logic rules for fields defined in `form_fields_per_document` + * + * @return self + */ + public function setFormFieldRules(?array $form_field_rules) + { + if (is_null($form_field_rules)) { + throw new InvalidArgumentException('non-nullable form_field_rules cannot be null'); + } + $this->container['form_field_rules'] = $form_field_rules; + + return $this; + } + + /** + * Gets form_fields_per_document + * + * @return SubFormFieldsPerDocumentBase[]|null + */ + public function getFormFieldsPerDocument() + { + return $this->container['form_fields_per_document']; + } + + /** + * Sets form_fields_per_document + * + * @param SubFormFieldsPerDocumentBase[]|null $form_fields_per_document The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * + * @return self + */ + public function setFormFieldsPerDocument(?array $form_fields_per_document) + { + if (is_null($form_fields_per_document)) { + throw new InvalidArgumentException('non-nullable form_fields_per_document cannot be null'); + } + $this->container['form_fields_per_document'] = $form_fields_per_document; + + return $this; + } + + /** + * Gets hide_text_tags + * + * @return bool|null + */ + public function getHideTextTags() + { + return $this->container['hide_text_tags']; + } + + /** + * Sets hide_text_tags + * + * @param bool|null $hide_text_tags Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + * + * @return self + */ + public function setHideTextTags(?bool $hide_text_tags) + { + if (is_null($hide_text_tags)) { + throw new InvalidArgumentException('non-nullable hide_text_tags cannot be null'); + } + $this->container['hide_text_tags'] = $hide_text_tags; + + return $this; + } + + /** + * Gets is_eid + * + * @return bool|null + */ + public function getIsEid() + { + return $this->container['is_eid']; + } + + /** + * Sets is_eid + * + * @param bool|null $is_eid Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + * + * @return self + */ + public function setIsEid(?bool $is_eid) + { + if (is_null($is_eid)) { + throw new InvalidArgumentException('non-nullable is_eid cannot be null'); + } + $this->container['is_eid'] = $is_eid; + + return $this; + } + + /** + * Gets message + * + * @return string|null + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * + * @param string|null $message the custom message in the email that will be sent to the signers + * + * @return self + */ + public function setMessage(?string $message) + { + if (is_null($message)) { + throw new InvalidArgumentException('non-nullable message cannot be null'); + } + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestEditRequest., must be smaller than or equal to 5000.'); + } + + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets metadata + * + * @return array|null + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * + * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return self + */ + public function setMetadata(?array $metadata) + { + if (is_null($metadata)) { + throw new InvalidArgumentException('non-nullable metadata cannot be null'); + } + + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets signing_options + * + * @return SubSigningOptions|null + */ + public function getSigningOptions() + { + return $this->container['signing_options']; + } + + /** + * Sets signing_options + * + * @param SubSigningOptions|null $signing_options signing_options + * + * @return self + */ + public function setSigningOptions(?SubSigningOptions $signing_options) + { + if (is_null($signing_options)) { + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + } + $this->container['signing_options'] = $signing_options; + + return $this; + } + + /** + * Gets signing_redirect_url + * + * @return string|null + */ + public function getSigningRedirectUrl() + { + return $this->container['signing_redirect_url']; + } + + /** + * Sets signing_redirect_url + * + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * + * @return self + */ + public function setSigningRedirectUrl(?string $signing_redirect_url) + { + if (is_null($signing_redirect_url)) { + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + } + $this->container['signing_redirect_url'] = $signing_redirect_url; + + return $this; + } + + /** + * Gets subject + * + * @return string|null + */ + public function getSubject() + { + return $this->container['subject']; + } + + /** + * Sets subject + * + * @param string|null $subject the subject in the email that will be sent to the signers + * + * @return self + */ + public function setSubject(?string $subject) + { + if (is_null($subject)) { + throw new InvalidArgumentException('non-nullable subject cannot be null'); + } + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestEditRequest., must be smaller than or equal to 255.'); + } + + $this->container['subject'] = $subject; + + return $this; + } + + /** + * Gets test_mode + * + * @return bool|null + */ + public function getTestMode() + { + return $this->container['test_mode']; + } + + /** + * Sets test_mode + * + * @param bool|null $test_mode Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setTestMode(?bool $test_mode) + { + if (is_null($test_mode)) { + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + } + $this->container['test_mode'] = $test_mode; + + return $this; + } + + /** + * Gets title + * + * @return string|null + */ + public function getTitle() + { + return $this->container['title']; + } + + /** + * Sets title + * + * @param string|null $title the title you want to assign to the SignatureRequest + * + * @return self + */ + public function setTitle(?string $title) + { + if (is_null($title)) { + throw new InvalidArgumentException('non-nullable title cannot be null'); + } + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestEditRequest., must be smaller than or equal to 255.'); + } + + $this->container['title'] = $title; + + return $this; + } + + /** + * Gets use_text_tags + * + * @return bool|null + */ + public function getUseTextTags() + { + return $this->container['use_text_tags']; + } + + /** + * Sets use_text_tags + * + * @param bool|null $use_text_tags Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + * + * @return self + */ + public function setUseTextTags(?bool $use_text_tags) + { + if (is_null($use_text_tags)) { + throw new InvalidArgumentException('non-nullable use_text_tags cannot be null'); + } + $this->container['use_text_tags'] = $use_text_tags; + + return $this; + } + + /** + * Gets expires_at + * + * @return int|null + */ + public function getExpiresAt() + { + return $this->container['expires_at']; + } + + /** + * Sets expires_at + * + * @param int|null $expires_at When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * + * @return self + */ + public function setExpiresAt(?int $expires_at) + { + if (is_null($expires_at)) { + array_push($this->openAPINullablesSetToNull, 'expires_at'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('expires_at', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['expires_at'] = $expires_at; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php new file mode 100644 index 000000000..cda7360db --- /dev/null +++ b/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php @@ -0,0 +1,956 @@ + + */ +class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SignatureRequestEditWithTemplateRequest'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'template_ids' => 'string[]', + 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]', + 'allow_decline' => 'bool', + 'ccs' => '\Dropbox\Sign\Model\SubCC[]', + 'client_id' => 'string', + 'custom_fields' => '\Dropbox\Sign\Model\SubCustomField[]', + 'files' => '\SplFileObject[]', + 'file_urls' => 'string[]', + 'is_eid' => 'bool', + 'message' => 'string', + 'metadata' => 'array', + 'signing_options' => '\Dropbox\Sign\Model\SubSigningOptions', + 'signing_redirect_url' => 'string', + 'subject' => 'string', + 'test_mode' => 'bool', + 'title' => 'string', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'template_ids' => null, + 'signers' => null, + 'allow_decline' => null, + 'ccs' => null, + 'client_id' => null, + 'custom_fields' => null, + 'files' => 'binary', + 'file_urls' => null, + 'is_eid' => null, + 'message' => null, + 'metadata' => null, + 'signing_options' => null, + 'signing_redirect_url' => null, + 'subject' => null, + 'test_mode' => null, + 'title' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'template_ids' => false, + 'signers' => false, + 'allow_decline' => false, + 'ccs' => false, + 'client_id' => false, + 'custom_fields' => false, + 'files' => false, + 'file_urls' => false, + 'is_eid' => false, + 'message' => false, + 'metadata' => false, + 'signing_options' => false, + 'signing_redirect_url' => false, + 'subject' => false, + 'test_mode' => false, + 'title' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'template_ids' => 'template_ids', + 'signers' => 'signers', + 'allow_decline' => 'allow_decline', + 'ccs' => 'ccs', + 'client_id' => 'client_id', + 'custom_fields' => 'custom_fields', + 'files' => 'files', + 'file_urls' => 'file_urls', + 'is_eid' => 'is_eid', + 'message' => 'message', + 'metadata' => 'metadata', + 'signing_options' => 'signing_options', + 'signing_redirect_url' => 'signing_redirect_url', + 'subject' => 'subject', + 'test_mode' => 'test_mode', + 'title' => 'title', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'template_ids' => 'setTemplateIds', + 'signers' => 'setSigners', + 'allow_decline' => 'setAllowDecline', + 'ccs' => 'setCcs', + 'client_id' => 'setClientId', + 'custom_fields' => 'setCustomFields', + 'files' => 'setFiles', + 'file_urls' => 'setFileUrls', + 'is_eid' => 'setIsEid', + 'message' => 'setMessage', + 'metadata' => 'setMetadata', + 'signing_options' => 'setSigningOptions', + 'signing_redirect_url' => 'setSigningRedirectUrl', + 'subject' => 'setSubject', + 'test_mode' => 'setTestMode', + 'title' => 'setTitle', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'template_ids' => 'getTemplateIds', + 'signers' => 'getSigners', + 'allow_decline' => 'getAllowDecline', + 'ccs' => 'getCcs', + 'client_id' => 'getClientId', + 'custom_fields' => 'getCustomFields', + 'files' => 'getFiles', + 'file_urls' => 'getFileUrls', + 'is_eid' => 'getIsEid', + 'message' => 'getMessage', + 'metadata' => 'getMetadata', + 'signing_options' => 'getSigningOptions', + 'signing_redirect_url' => 'getSigningRedirectUrl', + 'subject' => 'getSubject', + 'test_mode' => 'getTestMode', + 'title' => 'getTitle', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('template_ids', $data ?? [], null); + $this->setIfExists('signers', $data ?? [], null); + $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('ccs', $data ?? [], null); + $this->setIfExists('client_id', $data ?? [], null); + $this->setIfExists('custom_fields', $data ?? [], null); + $this->setIfExists('files', $data ?? [], null); + $this->setIfExists('file_urls', $data ?? [], null); + $this->setIfExists('is_eid', $data ?? [], false); + $this->setIfExists('message', $data ?? [], null); + $this->setIfExists('metadata', $data ?? [], null); + $this->setIfExists('signing_options', $data ?? [], null); + $this->setIfExists('signing_redirect_url', $data ?? [], null); + $this->setIfExists('subject', $data ?? [], null); + $this->setIfExists('test_mode', $data ?? [], false); + $this->setIfExists('title', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): SignatureRequestEditWithTemplateRequest + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): SignatureRequestEditWithTemplateRequest + { + /** @var SignatureRequestEditWithTemplateRequest */ + return ObjectSerializer::deserialize( + $data, + SignatureRequestEditWithTemplateRequest::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['template_ids'] === null) { + $invalidProperties[] = "'template_ids' can't be null"; + } + if ($this->container['signers'] === null) { + $invalidProperties[] = "'signers' can't be null"; + } + if (!is_null($this->container['message']) && (mb_strlen($this->container['message']) > 5000)) { + $invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000."; + } + + if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 255)) { + $invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 255."; + } + + if (!is_null($this->container['title']) && (mb_strlen($this->container['title']) > 255)) { + $invalidProperties[] = "invalid value for 'title', the character length must be smaller than or equal to 255."; + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets template_ids + * + * @return string[] + */ + public function getTemplateIds() + { + return $this->container['template_ids']; + } + + /** + * Sets template_ids + * + * @param string[] $template_ids use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used + * + * @return self + */ + public function setTemplateIds(array $template_ids) + { + if (is_null($template_ids)) { + throw new InvalidArgumentException('non-nullable template_ids cannot be null'); + } + $this->container['template_ids'] = $template_ids; + + return $this; + } + + /** + * Gets signers + * + * @return SubSignatureRequestTemplateSigner[] + */ + public function getSigners() + { + return $this->container['signers']; + } + + /** + * Sets signers + * + * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * + * @return self + */ + public function setSigners(array $signers) + { + if (is_null($signers)) { + throw new InvalidArgumentException('non-nullable signers cannot be null'); + } + $this->container['signers'] = $signers; + + return $this; + } + + /** + * Gets allow_decline + * + * @return bool|null + */ + public function getAllowDecline() + { + return $this->container['allow_decline']; + } + + /** + * Sets allow_decline + * + * @param bool|null $allow_decline Allows signers to decline to sign a document if `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowDecline(?bool $allow_decline) + { + if (is_null($allow_decline)) { + throw new InvalidArgumentException('non-nullable allow_decline cannot be null'); + } + $this->container['allow_decline'] = $allow_decline; + + return $this; + } + + /** + * Gets ccs + * + * @return SubCC[]|null + */ + public function getCcs() + { + return $this->container['ccs']; + } + + /** + * Sets ccs + * + * @param SubCC[]|null $ccs Add CC email recipients. Required when a CC role exists for the Template. + * + * @return self + */ + public function setCcs(?array $ccs) + { + if (is_null($ccs)) { + throw new InvalidArgumentException('non-nullable ccs cannot be null'); + } + $this->container['ccs'] = $ccs; + + return $this; + } + + /** + * Gets client_id + * + * @return string|null + */ + public function getClientId() + { + return $this->container['client_id']; + } + + /** + * Sets client_id + * + * @param string|null $client_id Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + * + * @return self + */ + public function setClientId(?string $client_id) + { + if (is_null($client_id)) { + throw new InvalidArgumentException('non-nullable client_id cannot be null'); + } + $this->container['client_id'] = $client_id; + + return $this; + } + + /** + * Gets custom_fields + * + * @return SubCustomField[]|null + */ + public function getCustomFields() + { + return $this->container['custom_fields']; + } + + /** + * Sets custom_fields + * + * @param SubCustomField[]|null $custom_fields An array defining values and options for custom fields. Required when a custom field exists in the Template. + * + * @return self + */ + public function setCustomFields(?array $custom_fields) + { + if (is_null($custom_fields)) { + throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); + } + $this->container['custom_fields'] = $custom_fields; + + return $this; + } + + /** + * Gets files + * + * @return SplFileObject[]|null + */ + public function getFiles() + { + return $this->container['files']; + } + + /** + * Sets files + * + * @param SplFileObject[]|null $files Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFiles(?array $files) + { + if (is_null($files)) { + throw new InvalidArgumentException('non-nullable files cannot be null'); + } + $this->container['files'] = $files; + + return $this; + } + + /** + * Gets file_urls + * + * @return string[]|null + */ + public function getFileUrls() + { + return $this->container['file_urls']; + } + + /** + * Sets file_urls + * + * @param string[]|null $file_urls Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * + * @return self + */ + public function setFileUrls(?array $file_urls) + { + if (is_null($file_urls)) { + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + } + $this->container['file_urls'] = $file_urls; + + return $this; + } + + /** + * Gets is_eid + * + * @return bool|null + */ + public function getIsEid() + { + return $this->container['is_eid']; + } + + /** + * Sets is_eid + * + * @param bool|null $is_eid Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + * + * @return self + */ + public function setIsEid(?bool $is_eid) + { + if (is_null($is_eid)) { + throw new InvalidArgumentException('non-nullable is_eid cannot be null'); + } + $this->container['is_eid'] = $is_eid; + + return $this; + } + + /** + * Gets message + * + * @return string|null + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * + * @param string|null $message the custom message in the email that will be sent to the signers + * + * @return self + */ + public function setMessage(?string $message) + { + if (is_null($message)) { + throw new InvalidArgumentException('non-nullable message cannot be null'); + } + if (mb_strlen($message) > 5000) { + throw new InvalidArgumentException('invalid length for $message when calling SignatureRequestEditWithTemplateRequest., must be smaller than or equal to 5000.'); + } + + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets metadata + * + * @return array|null + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * + * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * + * @return self + */ + public function setMetadata(?array $metadata) + { + if (is_null($metadata)) { + throw new InvalidArgumentException('non-nullable metadata cannot be null'); + } + + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets signing_options + * + * @return SubSigningOptions|null + */ + public function getSigningOptions() + { + return $this->container['signing_options']; + } + + /** + * Sets signing_options + * + * @param SubSigningOptions|null $signing_options signing_options + * + * @return self + */ + public function setSigningOptions(?SubSigningOptions $signing_options) + { + if (is_null($signing_options)) { + throw new InvalidArgumentException('non-nullable signing_options cannot be null'); + } + $this->container['signing_options'] = $signing_options; + + return $this; + } + + /** + * Gets signing_redirect_url + * + * @return string|null + */ + public function getSigningRedirectUrl() + { + return $this->container['signing_redirect_url']; + } + + /** + * Sets signing_redirect_url + * + * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * + * @return self + */ + public function setSigningRedirectUrl(?string $signing_redirect_url) + { + if (is_null($signing_redirect_url)) { + throw new InvalidArgumentException('non-nullable signing_redirect_url cannot be null'); + } + $this->container['signing_redirect_url'] = $signing_redirect_url; + + return $this; + } + + /** + * Gets subject + * + * @return string|null + */ + public function getSubject() + { + return $this->container['subject']; + } + + /** + * Sets subject + * + * @param string|null $subject the subject in the email that will be sent to the signers + * + * @return self + */ + public function setSubject(?string $subject) + { + if (is_null($subject)) { + throw new InvalidArgumentException('non-nullable subject cannot be null'); + } + if (mb_strlen($subject) > 255) { + throw new InvalidArgumentException('invalid length for $subject when calling SignatureRequestEditWithTemplateRequest., must be smaller than or equal to 255.'); + } + + $this->container['subject'] = $subject; + + return $this; + } + + /** + * Gets test_mode + * + * @return bool|null + */ + public function getTestMode() + { + return $this->container['test_mode']; + } + + /** + * Sets test_mode + * + * @param bool|null $test_mode Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setTestMode(?bool $test_mode) + { + if (is_null($test_mode)) { + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + } + $this->container['test_mode'] = $test_mode; + + return $this; + } + + /** + * Gets title + * + * @return string|null + */ + public function getTitle() + { + return $this->container['title']; + } + + /** + * Sets title + * + * @param string|null $title the title you want to assign to the SignatureRequest + * + * @return self + */ + public function setTitle(?string $title) + { + if (is_null($title)) { + throw new InvalidArgumentException('non-nullable title cannot be null'); + } + if (mb_strlen($title) > 255) { + throw new InvalidArgumentException('invalid length for $title when calling SignatureRequestEditWithTemplateRequest., must be smaller than or equal to 255.'); + } + + $this->container['title'] = $title; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/python/README.md b/sdks/python/README.md index c74588445..574b1bc36 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -135,6 +135,10 @@ Class | Method | HTTP request | Description ```SignatureRequestApi``` | [```signature_request_cancel```](docs/SignatureRequestApi.md#signature_request_cancel) | ```POST /signature_request/cancel/{signature_request_id}``` | Cancel Incomplete Signature Request| ```SignatureRequestApi``` | [```signature_request_create_embedded```](docs/SignatureRequestApi.md#signature_request_create_embedded) | ```POST /signature_request/create_embedded``` | Create Embedded Signature Request| ```SignatureRequestApi``` | [```signature_request_create_embedded_with_template```](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | ```POST /signature_request/create_embedded_with_template``` | Create Embedded Signature Request with Template| +```SignatureRequestApi``` | [```signature_request_edit```](docs/SignatureRequestApi.md#signature_request_edit) | ```PUT /signature_request/edit/{signature_request_id}``` | Edit Signature Request| +```SignatureRequestApi``` | [```signature_request_edit_embedded```](docs/SignatureRequestApi.md#signature_request_edit_embedded) | ```PUT /signature_request/edit_embedded/{signature_request_id}``` | Edit Embedded Signature Request| +```SignatureRequestApi``` | [```signature_request_edit_embedded_with_template```](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | ```PUT /signature_request/edit_embedded_with_template/{signature_request_id}``` | Edit Embedded Signature Request with Template| +```SignatureRequestApi``` | [```signature_request_edit_with_template```](docs/SignatureRequestApi.md#signature_request_edit_with_template) | ```PUT /signature_request/edit_with_template/{signature_request_id}``` | Edit Signature Request With Template| ```SignatureRequestApi``` | [```signature_request_files```](docs/SignatureRequestApi.md#signature_request_files) | ```GET /signature_request/files/{signature_request_id}``` | Download Files| ```SignatureRequestApi``` | [```signature_request_files_as_data_uri```](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | ```GET /signature_request/files_as_data_uri/{signature_request_id}``` | Download Files as Data Uri| ```SignatureRequestApi``` | [```signature_request_files_as_file_url```](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | ```GET /signature_request/files_as_file_url/{signature_request_id}``` | Download Files as File Url| @@ -238,6 +242,10 @@ Class | Method | HTTP request | Description - [SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) diff --git a/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index 2db45f1a5..1141fb8ee 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ Method | HTTP request | Description |[```signature_request_cancel```](SignatureRequestApi.md#signature_request_cancel) | ```POST /signature_request/cancel/{signature_request_id}``` | Cancel Incomplete Signature Request| |[```signature_request_create_embedded```](SignatureRequestApi.md#signature_request_create_embedded) | ```POST /signature_request/create_embedded``` | Create Embedded Signature Request| |[```signature_request_create_embedded_with_template```](SignatureRequestApi.md#signature_request_create_embedded_with_template) | ```POST /signature_request/create_embedded_with_template``` | Create Embedded Signature Request with Template| +|[```signature_request_edit```](SignatureRequestApi.md#signature_request_edit) | ```PUT /signature_request/edit/{signature_request_id}``` | Edit Signature Request| +|[```signature_request_edit_embedded```](SignatureRequestApi.md#signature_request_edit_embedded) | ```PUT /signature_request/edit_embedded/{signature_request_id}``` | Edit Embedded Signature Request| +|[```signature_request_edit_embedded_with_template```](SignatureRequestApi.md#signature_request_edit_embedded_with_template) | ```PUT /signature_request/edit_embedded_with_template/{signature_request_id}``` | Edit Embedded Signature Request with Template| +|[```signature_request_edit_with_template```](SignatureRequestApi.md#signature_request_edit_with_template) | ```PUT /signature_request/edit_with_template/{signature_request_id}``` | Edit Signature Request With Template| |[```signature_request_files```](SignatureRequestApi.md#signature_request_files) | ```GET /signature_request/files/{signature_request_id}``` | Download Files| |[```signature_request_files_as_data_uri```](SignatureRequestApi.md#signature_request_files_as_data_uri) | ```GET /signature_request/files_as_data_uri/{signature_request_id}``` | Download Files as Data Uri| |[```signature_request_files_as_file_url```](SignatureRequestApi.md#signature_request_files_as_file_url) | ```GET /signature_request/files_as_file_url/{signature_request_id}``` | Download Files as File Url| @@ -494,6 +498,414 @@ with ApiClient(configuration) as api_client: [[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) +# ```signature_request_edit``` +> ```SignatureRequestGetResponse signature_request_edit(signature_request_id, signature_request_edit_request)``` + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", + # or, configure Bearer (JWT) authorization: oauth2 + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_api = apis.SignatureRequestApi(api_client) + + signer_1 = models.SubSignatureRequestSigner( + email_address="jack@example.com", + name="Jack", + order=0, + ) + + signer_2 = models.SubSignatureRequestSigner( + email_address="jill@example.com", + name="Jill", + order=1, + ) + + signing_options = models.SubSigningOptions( + draw=True, + type=True, + upload=True, + phone=True, + default_type="draw", + ) + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + data = models.SignatureRequestEditRequest( + title="NDA with Acme Co.", + subject="The NDA we talked about", + message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers=[signer_1, signer_2], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[open("example_signature_request.pdf", "rb")], + metadata={ + "custom_id": 1234, + "custom_text": "NDA #9", + }, + signing_options=signing_options, + field_options=field_options, + test_mode=True, + ) + + signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + + try: + response = signature_request_api.signature_request_edit( + signature_request_id, data + ) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_request` | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + +# ```signature_request_edit_embedded``` +> ```SignatureRequestGetResponse signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request)``` + +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", + # or, configure Bearer (JWT) authorization: oauth2 + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_api = apis.SignatureRequestApi(api_client) + + signer_1 = models.SubSignatureRequestSigner( + email_address="jack@example.com", + name="Jack", + order=0, + ) + + signer_2 = models.SubSignatureRequestSigner( + email_address="jill@example.com", + name="Jill", + order=1, + ) + + signing_options = models.SubSigningOptions( + draw=True, + type=True, + upload=True, + phone=True, + default_type="draw", + ) + + data = models.SignatureRequestEditEmbeddedRequest( + client_id="ec64a202072370a737edf4a0eb7f4437", + title="NDA with Acme Co.", + subject="The NDA we talked about", + message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", + signers=[signer_1, signer_2], + cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], + files=[open("example_signature_request.pdf", "rb")], + signing_options=signing_options, + test_mode=True, + ) + + signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + + try: + response = signature_request_api.signature_request_edit_embedded( + signature_request_id, data + ) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_request` | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + +# ```signature_request_edit_embedded_with_template``` +> ```SignatureRequestGetResponse signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request)``` + +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", + # or, configure Bearer (JWT) authorization: oauth2 + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_api = apis.SignatureRequestApi(api_client) + + signer_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + email_address="jack@example.com", + name="Jack", + ) + + signing_options = models.SubSigningOptions( + draw=True, + type=True, + upload=True, + phone=True, + default_type="draw", + ) + + data = models.SignatureRequestEditEmbeddedWithTemplateRequest( + client_id="ec64a202072370a737edf4a0eb7f4437", + template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], + subject="Purchase Order", + message="Glad we could come to an agreement.", + signers=[signer_1], + signing_options=signing_options, + test_mode=True, + ) + + signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + + try: + response = signature_request_api.signature_request_edit_embedded_with_template( + signature_request_id, data + ) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_with_template_request` | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + +# ```signature_request_edit_with_template``` +> ```SignatureRequestGetResponse signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request)``` + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", + # or, configure Bearer (JWT) authorization: oauth2 + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_api = apis.SignatureRequestApi(api_client) + + signer_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + email_address="george@example.com", + name="George", + ) + + cc_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + custom_field_1 = models.SubCustomField( + name="Cost", + value="$20,000", + editor="Client", + required=True, + ) + + signing_options = models.SubSigningOptions( + draw=True, + type=True, + upload=True, + phone=False, + default_type="draw", + ) + + data = models.SignatureRequestSendWithTemplateRequest( + template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], + subject="Purchase Order", + message="Glad we could come to an agreement.", + signers=[signer_1], + ccs=[cc_1], + custom_fields=[custom_field_1], + signing_options=signing_options, + test_mode=True, + ) + + signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + + try: + response = signature_request_api.signature_request_edit_with_template( + signature_request_id, data + ) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **str** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_with_template_request` | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### 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) + # ```signature_request_files``` > ```io.IOBase signature_request_files(signature_request_id)``` diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..5fdb45e26 --- /dev/null +++ b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,34 @@ +# SignatureRequestEditEmbeddedRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```List[SubFormFieldGroup]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[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/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..9b5c9eb7d --- /dev/null +++ b/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,25 @@ +# SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | + +[[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/sdks/python/docs/SignatureRequestEditRequest.md b/sdks/python/docs/SignatureRequestEditRequest.md new file mode 100644 index 000000000..24aefcd32 --- /dev/null +++ b/sdks/python/docs/SignatureRequestEditRequest.md @@ -0,0 +1,35 @@ +# SignatureRequestEditRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | +| `client_id` | ```str``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```List[SubFormFieldGroup]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + +[[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/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..bf3b21f36 --- /dev/null +++ b/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,26 @@ +# SignatureRequestEditWithTemplateRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```str``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | +| `message` | ```str``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```str``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | +| `title` | ```str``` | The title you want to assign to the SignatureRequest. | | + +[[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/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index 53deb8f21..d280fc547 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -125,6 +125,18 @@ from dropbox_sign.models.signature_request_create_embedded_with_template_request import ( SignatureRequestCreateEmbeddedWithTemplateRequest, ) +from dropbox_sign.models.signature_request_edit_embedded_request import ( + SignatureRequestEditEmbeddedRequest, +) +from dropbox_sign.models.signature_request_edit_embedded_with_template_request import ( + SignatureRequestEditEmbeddedWithTemplateRequest, +) +from dropbox_sign.models.signature_request_edit_request import ( + SignatureRequestEditRequest, +) +from dropbox_sign.models.signature_request_edit_with_template_request import ( + SignatureRequestEditWithTemplateRequest, +) from dropbox_sign.models.signature_request_get_response import ( SignatureRequestGetResponse, ) diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index 98f08aed8..9f02599d5 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -35,6 +35,18 @@ from dropbox_sign.models.signature_request_create_embedded_with_template_request import ( SignatureRequestCreateEmbeddedWithTemplateRequest, ) +from dropbox_sign.models.signature_request_edit_embedded_request import ( + SignatureRequestEditEmbeddedRequest, +) +from dropbox_sign.models.signature_request_edit_embedded_with_template_request import ( + SignatureRequestEditEmbeddedWithTemplateRequest, +) +from dropbox_sign.models.signature_request_edit_request import ( + SignatureRequestEditRequest, +) +from dropbox_sign.models.signature_request_edit_with_template_request import ( + SignatureRequestEditWithTemplateRequest, +) from dropbox_sign.models.signature_request_get_response import ( SignatureRequestGetResponse, ) @@ -1433,6 +1445,1196 @@ def _signature_request_create_embedded_with_template_serialize( _request_auth=_request_auth, ) + @validate_call + def signature_request_edit( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_request: SignatureRequestEditRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureRequestGetResponse: + """Edit Signature Request + + Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_request: (required) + :type signature_request_edit_request: SignatureRequestEditRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_serialize( + signature_request_id=signature_request_id, + signature_request_edit_request=signature_request_edit_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_request: SignatureRequestEditRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureRequestGetResponse]: + """Edit Signature Request + + Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_request: (required) + :type signature_request_edit_request: SignatureRequestEditRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_serialize( + signature_request_id=signature_request_id, + signature_request_edit_request=signature_request_edit_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_request: SignatureRequestEditRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit Signature Request + + Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_request: (required) + :type signature_request_edit_request: SignatureRequestEditRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_serialize( + signature_request_id=signature_request_id, + signature_request_edit_request=signature_request_edit_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_serialize( + self, + signature_request_id, + signature_request_edit_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if signature_request_edit_request is not None and has_files is False: + _body_params = signature_request_edit_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def signature_request_edit_embedded( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureRequestGetResponse: + """Edit Embedded Signature Request + + Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_embedded_request: (required) + :type signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_embedded_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureRequestGetResponse]: + """Edit Embedded Signature Request + + Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_embedded_request: (required) + :type signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_embedded_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit Embedded Signature Request + + Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_embedded_request: (required) + :type signature_request_edit_embedded_request: SignatureRequestEditEmbeddedRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_embedded_serialize( + self, + signature_request_id, + signature_request_edit_embedded_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_embedded_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if signature_request_edit_embedded_request is not None and has_files is False: + _body_params = signature_request_edit_embedded_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit_embedded/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def signature_request_edit_embedded_with_template( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureRequestGetResponse: + """Edit Embedded Signature Request with Template + + Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_embedded_with_template_request: (required) + :type signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_embedded_with_template_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureRequestGetResponse]: + """Edit Embedded Signature Request with Template + + Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_embedded_with_template_request: (required) + :type signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_embedded_with_template_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit Embedded Signature Request with Template + + Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_embedded_with_template_request: (required) + :type signature_request_edit_embedded_with_template_request: SignatureRequestEditEmbeddedWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_embedded_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_embedded_with_template_serialize( + self, + signature_request_id, + signature_request_edit_embedded_with_template_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_embedded_with_template_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ( + signature_request_edit_embedded_with_template_request is not None + and has_files is False + ): + _body_params = signature_request_edit_embedded_with_template_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit_embedded_with_template/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def signature_request_edit_with_template( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureRequestGetResponse: + """Edit Signature Request With Template + + Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_with_template_request: (required) + :type signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def signature_request_edit_with_template_with_http_info( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureRequestGetResponse]: + """Edit Signature Request With Template + + Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_with_template_request: (required) + :type signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def signature_request_edit_with_template_without_preload_content( + self, + signature_request_id: Annotated[ + StrictStr, Field(description="The id of the SignatureRequest to edit.") + ], + signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit Signature Request With Template + + Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + + :param signature_request_id: The id of the SignatureRequest to edit. (required) + :type signature_request_id: str + :param signature_request_edit_with_template_request: (required) + :type signature_request_edit_with_template_request: SignatureRequestEditWithTemplateRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_request_edit_with_template_serialize( + signature_request_id=signature_request_id, + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "SignatureRequestGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _signature_request_edit_with_template_serialize( + self, + signature_request_id, + signature_request_edit_with_template_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = signature_request_edit_with_template_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + if signature_request_id is not None: + _path_params["signature_request_id"] = signature_request_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ( + signature_request_edit_with_template_request is not None + and has_files is False + ): + _body_params = signature_request_edit_with_template_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="PUT", + resource_path="/signature_request/edit_with_template/{signature_request_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + @validate_call def signature_request_files( self, diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 71b8e6f5b..fd5331ae1 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -108,6 +108,18 @@ from dropbox_sign.models.signature_request_create_embedded_with_template_request import ( SignatureRequestCreateEmbeddedWithTemplateRequest, ) +from dropbox_sign.models.signature_request_edit_embedded_request import ( + SignatureRequestEditEmbeddedRequest, +) +from dropbox_sign.models.signature_request_edit_embedded_with_template_request import ( + SignatureRequestEditEmbeddedWithTemplateRequest, +) +from dropbox_sign.models.signature_request_edit_request import ( + SignatureRequestEditRequest, +) +from dropbox_sign.models.signature_request_edit_with_template_request import ( + SignatureRequestEditWithTemplateRequest, +) from dropbox_sign.models.signature_request_get_response import ( SignatureRequestGetResponse, ) diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py new file mode 100644 index 000000000..761134fe9 --- /dev/null +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py @@ -0,0 +1,442 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_attachment import SubAttachment +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_field_options import SubFieldOptions +from dropbox_sign.models.sub_form_field_group import SubFormFieldGroup +from dropbox_sign.models.sub_form_field_rule import SubFormFieldRule +from dropbox_sign.models.sub_form_fields_per_document_base import ( + SubFormFieldsPerDocumentBase, +) +from dropbox_sign.models.sub_signature_request_grouped_signers import ( + SubSignatureRequestGroupedSigners, +) +from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class SignatureRequestEditEmbeddedRequest(BaseModel): + """ + SignatureRequestEditEmbeddedRequest + """ # noqa: E501 + + client_id: StrictStr = Field( + description="Client id of the app you're using to create this embedded signature request. Used for security purposes." + ) + files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + default=None, + description="Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + signers: Optional[List[SubSignatureRequestSigner]] = Field( + default=None, + description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( + default=None, + description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + allow_reassign: Optional[StrictBool] = Field( + default=False, + description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.", + ) + attachments: Optional[List[SubAttachment]] = Field( + default=None, description="A list describing the attachments" + ) + cc_email_addresses: Optional[List[StrictStr]] = Field( + default=None, description="The email addresses that should be CCed." + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description='When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.', + ) + field_options: Optional[SubFieldOptions] = None + form_field_groups: Optional[List[SubFormFieldGroup]] = Field( + default=None, + description="Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.", + ) + form_field_rules: Optional[List[SubFormFieldRule]] = Field( + default=None, + description="Conditional Logic rules for fields defined in `form_fields_per_document`.", + ) + form_fields_per_document: Optional[List[SubFormFieldsPerDocumentBase]] = Field( + default=None, + description="The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`", + ) + hide_text_tags: Optional[StrictBool] = Field( + default=False, + description="Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + use_text_tags: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", + ) + populate_auto_fill_fields: Optional[StrictBool] = Field( + default=False, + description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", + ) + expires_at: Optional[StrictInt] = Field( + default=None, + description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", + ) + __properties: ClassVar[List[str]] = [ + "client_id", + "files", + "file_urls", + "signers", + "grouped_signers", + "allow_decline", + "allow_reassign", + "attachments", + "cc_email_addresses", + "custom_fields", + "field_options", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + "hide_text_tags", + "message", + "metadata", + "signing_options", + "subject", + "test_mode", + "title", + "use_text_tags", + "populate_auto_fill_fields", + "expires_at", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grouped_signers (list) + _items = [] + if self.grouped_signers: + for _item_grouped_signers in self.grouped_signers: + if _item_grouped_signers: + _items.append(_item_grouped_signers.to_dict()) + _dict["grouped_signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of field_options + if self.field_options: + _dict["field_options"] = self.field_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in form_field_groups (list) + _items = [] + if self.form_field_groups: + for _item_form_field_groups in self.form_field_groups: + if _item_form_field_groups: + _items.append(_item_form_field_groups.to_dict()) + _dict["form_field_groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_field_rules (list) + _items = [] + if self.form_field_rules: + for _item_form_field_rules in self.form_field_rules: + if _item_form_field_rules: + _items.append(_item_form_field_rules.to_dict()) + _dict["form_field_rules"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_fields_per_document (list) + _items = [] + if self.form_fields_per_document: + for _item_form_fields_per_document in self.form_fields_per_document: + if _item_form_fields_per_document: + _items.append(_item_form_fields_per_document.to_dict()) + _dict["form_fields_per_document"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "client_id": obj.get("client_id"), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "signers": ( + [ + SubSignatureRequestSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "grouped_signers": ( + [ + SubSignatureRequestGroupedSigners.from_dict(_item) + for _item in obj["grouped_signers"] + ] + if obj.get("grouped_signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "allow_reassign": ( + obj.get("allow_reassign") + if obj.get("allow_reassign") is not None + else False + ), + "attachments": ( + [SubAttachment.from_dict(_item) for _item in obj["attachments"]] + if obj.get("attachments") is not None + else None + ), + "cc_email_addresses": obj.get("cc_email_addresses"), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "field_options": ( + SubFieldOptions.from_dict(obj["field_options"]) + if obj.get("field_options") is not None + else None + ), + "form_field_groups": ( + [ + SubFormFieldGroup.from_dict(_item) + for _item in obj["form_field_groups"] + ] + if obj.get("form_field_groups") is not None + else None + ), + "form_field_rules": ( + [ + SubFormFieldRule.from_dict(_item) + for _item in obj["form_field_rules"] + ] + if obj.get("form_field_rules") is not None + else None + ), + "form_fields_per_document": ( + [ + SubFormFieldsPerDocumentBase.from_dict(_item) + for _item in obj["form_fields_per_document"] + ] + if obj.get("form_fields_per_document") is not None + else None + ), + "hide_text_tags": ( + obj.get("hide_text_tags") + if obj.get("hide_text_tags") is not None + else False + ), + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + "use_text_tags": ( + obj.get("use_text_tags") + if obj.get("use_text_tags") is not None + else False + ), + "populate_auto_fill_fields": ( + obj.get("populate_auto_fill_fields") + if obj.get("populate_auto_fill_fields") is not None + else False + ), + "expires_at": obj.get("expires_at"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "client_id": "(str,)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "signers": "(List[SubSignatureRequestSigner],)", + "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", + "allow_decline": "(bool,)", + "allow_reassign": "(bool,)", + "attachments": "(List[SubAttachment],)", + "cc_email_addresses": "(List[str],)", + "custom_fields": "(List[SubCustomField],)", + "field_options": "(SubFieldOptions,)", + "form_field_groups": "(List[SubFormFieldGroup],)", + "form_field_rules": "(List[SubFormFieldRule],)", + "form_fields_per_document": "(List[SubFormFieldsPerDocumentBase],)", + "hide_text_tags": "(bool,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + "use_text_tags": "(bool,)", + "populate_auto_fill_fields": "(bool,)", + "expires_at": "(int,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "files", + "file_urls", + "signers", + "grouped_signers", + "attachments", + "cc_email_addresses", + "custom_fields", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + ] diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py new file mode 100644 index 000000000..932165f3b --- /dev/null +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py @@ -0,0 +1,288 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_cc import SubCC +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_signature_request_template_signer import ( + SubSignatureRequestTemplateSigner, +) +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class SignatureRequestEditEmbeddedWithTemplateRequest(BaseModel): + """ + SignatureRequestEditEmbeddedWithTemplateRequest + """ # noqa: E501 + + template_ids: List[StrictStr] = Field( + description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used." + ) + client_id: StrictStr = Field( + description="Client id of the app you're using to create this embedded signature request. Used for security purposes." + ) + signers: List[SubSignatureRequestTemplateSigner] = Field( + description="Add Signers to your Templated-based Signature Request." + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + ccs: Optional[List[SubCC]] = Field( + default=None, + description="Add CC email recipients. Required when a CC role exists for the Template.", + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description="An array defining values and options for custom fields. Required when a custom field exists in the Template.", + ) + files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + default=None, + description="Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + populate_auto_fill_fields: Optional[StrictBool] = Field( + default=False, + description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", + ) + __properties: ClassVar[List[str]] = [ + "template_ids", + "client_id", + "signers", + "allow_decline", + "ccs", + "custom_fields", + "files", + "file_urls", + "message", + "metadata", + "signing_options", + "subject", + "test_mode", + "title", + "populate_auto_fill_fields", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedWithTemplateRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in ccs (list) + _items = [] + if self.ccs: + for _item_ccs in self.ccs: + if _item_ccs: + _items.append(_item_ccs.to_dict()) + _dict["ccs"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditEmbeddedWithTemplateRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "template_ids": obj.get("template_ids"), + "client_id": obj.get("client_id"), + "signers": ( + [ + SubSignatureRequestTemplateSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "ccs": ( + [SubCC.from_dict(_item) for _item in obj["ccs"]] + if obj.get("ccs") is not None + else None + ), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + "populate_auto_fill_fields": ( + obj.get("populate_auto_fill_fields") + if obj.get("populate_auto_fill_fields") is not None + else False + ), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "template_ids": "(List[str],)", + "client_id": "(str,)", + "signers": "(List[SubSignatureRequestTemplateSigner],)", + "allow_decline": "(bool,)", + "ccs": "(List[SubCC],)", + "custom_fields": "(List[SubCustomField],)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + "populate_auto_fill_fields": "(bool,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "template_ids", + "signers", + "ccs", + "custom_fields", + "files", + "file_urls", + ] diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_request.py new file mode 100644 index 000000000..7b3a96db4 --- /dev/null +++ b/sdks/python/dropbox_sign/models/signature_request_edit_request.py @@ -0,0 +1,446 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_attachment import SubAttachment +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_field_options import SubFieldOptions +from dropbox_sign.models.sub_form_field_group import SubFormFieldGroup +from dropbox_sign.models.sub_form_field_rule import SubFormFieldRule +from dropbox_sign.models.sub_form_fields_per_document_base import ( + SubFormFieldsPerDocumentBase, +) +from dropbox_sign.models.sub_signature_request_grouped_signers import ( + SubSignatureRequestGroupedSigners, +) +from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class SignatureRequestEditRequest(BaseModel): + """ + SignatureRequestEditRequest + """ # noqa: E501 + + files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + default=None, + description="Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + signers: Optional[List[SubSignatureRequestSigner]] = Field( + default=None, + description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( + default=None, + description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + allow_reassign: Optional[StrictBool] = Field( + default=False, + description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", + ) + attachments: Optional[List[SubAttachment]] = Field( + default=None, description="A list describing the attachments" + ) + cc_email_addresses: Optional[List[StrictStr]] = Field( + default=None, description="The email addresses that should be CCed." + ) + client_id: Optional[StrictStr] = Field( + default=None, + description="The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.", + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description='When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.', + ) + field_options: Optional[SubFieldOptions] = None + form_field_groups: Optional[List[SubFormFieldGroup]] = Field( + default=None, + description="Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.", + ) + form_field_rules: Optional[List[SubFormFieldRule]] = Field( + default=None, + description="Conditional Logic rules for fields defined in `form_fields_per_document`.", + ) + form_fields_per_document: Optional[List[SubFormFieldsPerDocumentBase]] = Field( + default=None, + description="The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`", + ) + hide_text_tags: Optional[StrictBool] = Field( + default=False, + description="Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.", + ) + is_eid: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + signing_redirect_url: Optional[StrictStr] = Field( + default=None, + description="The URL you want signers redirected to after they successfully sign.", + ) + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + use_text_tags: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", + ) + expires_at: Optional[StrictInt] = Field( + default=None, + description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", + ) + __properties: ClassVar[List[str]] = [ + "files", + "file_urls", + "signers", + "grouped_signers", + "allow_decline", + "allow_reassign", + "attachments", + "cc_email_addresses", + "client_id", + "custom_fields", + "field_options", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + "hide_text_tags", + "is_eid", + "message", + "metadata", + "signing_options", + "signing_redirect_url", + "subject", + "test_mode", + "title", + "use_text_tags", + "expires_at", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grouped_signers (list) + _items = [] + if self.grouped_signers: + for _item_grouped_signers in self.grouped_signers: + if _item_grouped_signers: + _items.append(_item_grouped_signers.to_dict()) + _dict["grouped_signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of field_options + if self.field_options: + _dict["field_options"] = self.field_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in form_field_groups (list) + _items = [] + if self.form_field_groups: + for _item_form_field_groups in self.form_field_groups: + if _item_form_field_groups: + _items.append(_item_form_field_groups.to_dict()) + _dict["form_field_groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_field_rules (list) + _items = [] + if self.form_field_rules: + for _item_form_field_rules in self.form_field_rules: + if _item_form_field_rules: + _items.append(_item_form_field_rules.to_dict()) + _dict["form_field_rules"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_fields_per_document (list) + _items = [] + if self.form_fields_per_document: + for _item_form_fields_per_document in self.form_fields_per_document: + if _item_form_fields_per_document: + _items.append(_item_form_fields_per_document.to_dict()) + _dict["form_fields_per_document"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "signers": ( + [ + SubSignatureRequestSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "grouped_signers": ( + [ + SubSignatureRequestGroupedSigners.from_dict(_item) + for _item in obj["grouped_signers"] + ] + if obj.get("grouped_signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "allow_reassign": ( + obj.get("allow_reassign") + if obj.get("allow_reassign") is not None + else False + ), + "attachments": ( + [SubAttachment.from_dict(_item) for _item in obj["attachments"]] + if obj.get("attachments") is not None + else None + ), + "cc_email_addresses": obj.get("cc_email_addresses"), + "client_id": obj.get("client_id"), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "field_options": ( + SubFieldOptions.from_dict(obj["field_options"]) + if obj.get("field_options") is not None + else None + ), + "form_field_groups": ( + [ + SubFormFieldGroup.from_dict(_item) + for _item in obj["form_field_groups"] + ] + if obj.get("form_field_groups") is not None + else None + ), + "form_field_rules": ( + [ + SubFormFieldRule.from_dict(_item) + for _item in obj["form_field_rules"] + ] + if obj.get("form_field_rules") is not None + else None + ), + "form_fields_per_document": ( + [ + SubFormFieldsPerDocumentBase.from_dict(_item) + for _item in obj["form_fields_per_document"] + ] + if obj.get("form_fields_per_document") is not None + else None + ), + "hide_text_tags": ( + obj.get("hide_text_tags") + if obj.get("hide_text_tags") is not None + else False + ), + "is_eid": obj.get("is_eid") if obj.get("is_eid") is not None else False, + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "signing_redirect_url": obj.get("signing_redirect_url"), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + "use_text_tags": ( + obj.get("use_text_tags") + if obj.get("use_text_tags") is not None + else False + ), + "expires_at": obj.get("expires_at"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "signers": "(List[SubSignatureRequestSigner],)", + "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", + "allow_decline": "(bool,)", + "allow_reassign": "(bool,)", + "attachments": "(List[SubAttachment],)", + "cc_email_addresses": "(List[str],)", + "client_id": "(str,)", + "custom_fields": "(List[SubCustomField],)", + "field_options": "(SubFieldOptions,)", + "form_field_groups": "(List[SubFormFieldGroup],)", + "form_field_rules": "(List[SubFormFieldRule],)", + "form_fields_per_document": "(List[SubFormFieldsPerDocumentBase],)", + "hide_text_tags": "(bool,)", + "is_eid": "(bool,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "signing_redirect_url": "(str,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + "use_text_tags": "(bool,)", + "expires_at": "(int,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "files", + "file_urls", + "signers", + "grouped_signers", + "attachments", + "cc_email_addresses", + "custom_fields", + "form_field_groups", + "form_field_rules", + "form_fields_per_document", + ] diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py new file mode 100644 index 000000000..8a9948136 --- /dev/null +++ b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py @@ -0,0 +1,290 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing_extensions import Annotated +from dropbox_sign.models.sub_cc import SubCC +from dropbox_sign.models.sub_custom_field import SubCustomField +from dropbox_sign.models.sub_signature_request_template_signer import ( + SubSignatureRequestTemplateSigner, +) +from dropbox_sign.models.sub_signing_options import SubSigningOptions +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class SignatureRequestEditWithTemplateRequest(BaseModel): + """ """ # noqa: E501 + + template_ids: List[StrictStr] = Field( + description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used." + ) + signers: List[SubSignatureRequestTemplateSigner] = Field( + description="Add Signers to your Templated-based Signature Request." + ) + allow_decline: Optional[StrictBool] = Field( + default=False, + description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", + ) + ccs: Optional[List[SubCC]] = Field( + default=None, + description="Add CC email recipients. Required when a CC role exists for the Template.", + ) + client_id: Optional[StrictStr] = Field( + default=None, + description="Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.", + ) + custom_fields: Optional[List[SubCustomField]] = Field( + default=None, + description="An array defining values and options for custom fields. Required when a custom field exists in the Template.", + ) + files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + default=None, + description="Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, + description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", + ) + is_eid: Optional[StrictBool] = Field( + default=False, + description="Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.", + ) + message: Optional[Annotated[str, Field(strict=True, max_length=5000)]] = Field( + default=None, + description="The custom message in the email that will be sent to the signers.", + ) + metadata: Optional[Dict[str, Any]] = Field( + default=None, + description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + ) + signing_options: Optional[SubSigningOptions] = None + signing_redirect_url: Optional[StrictStr] = Field( + default=None, + description="The URL you want signers redirected to after they successfully sign.", + ) + subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The subject in the email that will be sent to the signers.", + ) + test_mode: Optional[StrictBool] = Field( + default=False, + description="Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.", + ) + title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( + default=None, + description="The title you want to assign to the SignatureRequest.", + ) + __properties: ClassVar[List[str]] = [ + "template_ids", + "signers", + "allow_decline", + "ccs", + "client_id", + "custom_fields", + "files", + "file_urls", + "is_eid", + "message", + "metadata", + "signing_options", + "signing_redirect_url", + "subject", + "test_mode", + "title", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestEditWithTemplateRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signers (list) + _items = [] + if self.signers: + for _item_signers in self.signers: + if _item_signers: + _items.append(_item_signers.to_dict()) + _dict["signers"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in ccs (list) + _items = [] + if self.ccs: + for _item_ccs in self.ccs: + if _item_ccs: + _items.append(_item_ccs.to_dict()) + _dict["ccs"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) + _items = [] + if self.custom_fields: + for _item_custom_fields in self.custom_fields: + if _item_custom_fields: + _items.append(_item_custom_fields.to_dict()) + _dict["custom_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signing_options + if self.signing_options: + _dict["signing_options"] = self.signing_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestEditWithTemplateRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "template_ids": obj.get("template_ids"), + "signers": ( + [ + SubSignatureRequestTemplateSigner.from_dict(_item) + for _item in obj["signers"] + ] + if obj.get("signers") is not None + else None + ), + "allow_decline": ( + obj.get("allow_decline") + if obj.get("allow_decline") is not None + else False + ), + "ccs": ( + [SubCC.from_dict(_item) for _item in obj["ccs"]] + if obj.get("ccs") is not None + else None + ), + "client_id": obj.get("client_id"), + "custom_fields": ( + [SubCustomField.from_dict(_item) for _item in obj["custom_fields"]] + if obj.get("custom_fields") is not None + else None + ), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "is_eid": obj.get("is_eid") if obj.get("is_eid") is not None else False, + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "signing_options": ( + SubSigningOptions.from_dict(obj["signing_options"]) + if obj.get("signing_options") is not None + else None + ), + "signing_redirect_url": obj.get("signing_redirect_url"), + "subject": obj.get("subject"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "title": obj.get("title"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "template_ids": "(List[str],)", + "signers": "(List[SubSignatureRequestTemplateSigner],)", + "allow_decline": "(bool,)", + "ccs": "(List[SubCC],)", + "client_id": "(str,)", + "custom_fields": "(List[SubCustomField],)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "is_eid": "(bool,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "signing_options": "(SubSigningOptions,)", + "signing_redirect_url": "(str,)", + "subject": "(str,)", + "test_mode": "(bool,)", + "title": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "template_ids", + "signers", + "ccs", + "custom_fields", + "files", + "file_urls", + ] diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index 87678fae4..a7d3b1847 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -141,6 +141,10 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_cancel**](docs/SignatureRequestApi.md#signature_request_cancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded**](docs/SignatureRequestApi.md#signature_request_create_embedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit**](docs/SignatureRequestApi.md#signature_request_edit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded**](docs/SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_with_template**](docs/SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files**](docs/SignatureRequestApi.md#signature_request_files) | **GET** /signature_request/files/{signature_request_id} | Download Files | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_data_uri**](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_file_url**](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -244,6 +248,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [Dropbox::Sign::SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [Dropbox::Sign::SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [Dropbox::Sign::SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [Dropbox::Sign::SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [Dropbox::Sign::SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [Dropbox::Sign::SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [Dropbox::Sign::SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) diff --git a/sdks/ruby/docs/SignatureRequestApi.md b/sdks/ruby/docs/SignatureRequestApi.md index 0261ffa5c..6e7299b54 100644 --- a/sdks/ruby/docs/SignatureRequestApi.md +++ b/sdks/ruby/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3* | [`signature_request_cancel`](SignatureRequestApi.md#signature_request_cancel) | **POST** `/signature_request/cancel/{signature_request_id}` | Cancel Incomplete Signature Request | | [`signature_request_create_embedded`](SignatureRequestApi.md#signature_request_create_embedded) | **POST** `/signature_request/create_embedded` | Create Embedded Signature Request | | [`signature_request_create_embedded_with_template`](SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** `/signature_request/create_embedded_with_template` | Create Embedded Signature Request with Template | +| [`signature_request_edit`](SignatureRequestApi.md#signature_request_edit) | **PUT** `/signature_request/edit/{signature_request_id}` | Edit Signature Request | +| [`signature_request_edit_embedded`](SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** `/signature_request/edit_embedded/{signature_request_id}` | Edit Embedded Signature Request | +| [`signature_request_edit_embedded_with_template`](SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** `/signature_request/edit_embedded_with_template/{signature_request_id}` | Edit Embedded Signature Request with Template | +| [`signature_request_edit_with_template`](SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** `/signature_request/edit_with_template/{signature_request_id}` | Edit Signature Request With Template | | [`signature_request_files`](SignatureRequestApi.md#signature_request_files) | **GET** `/signature_request/files/{signature_request_id}` | Download Files | | [`signature_request_files_as_data_uri`](SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** `/signature_request/files_as_data_uri/{signature_request_id}` | Download Files as Data Uri | | [`signature_request_files_as_file_url`](SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** `/signature_request/files_as_file_url/{signature_request_id}` | Download Files as File Url | @@ -504,6 +508,417 @@ end - **Accept**: application/json +## `signature_request_edit` + +> ` signature_request_edit(signature_request_id, signature_request_edit_request)` + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" + + # or, configure Bearer (JWT) authorization: oauth2 + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_api = Dropbox::Sign::SignatureRequestApi.new + +signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signer_1.email_address = "jack@example.com" +signer_1.name = "Jack" +signer_1.order = 0 + +signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signer_2.email_address = "jill@example.com" +signer_2.name = "Jill" +signer_2.order = 1 + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.draw = true +signing_options.type = true +signing_options.upload = true +signing_options.phone = true +signing_options.default_type = "draw" + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +data = Dropbox::Sign::SignatureRequestEditRequest.new +data.title = "NDA with Acme Co." +data.subject = "The NDA we talked about" +data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." +data.signers = [signer_1, signer_2] +data.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +data.files = [File.new("example_signature_request.pdf", "r")] +data.metadata = { + custom_id: 1234, + custom_text: "NDA #9", +} +data.signing_options = signing_options +data.field_options = field_options +data.test_mode = true + +signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + +begin + result = signature_request_api.signature_request_edit(signature_request_id, data) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `signature_request_edit_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request)` + +```ruby +begin + # Edit Signature Request + data, status_code, headers = api_instance.signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_request` | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + +## `signature_request_edit_embedded` + +> ` signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request)` + +Edit Embedded Signature Request + +Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" + + # or, configure Bearer (JWT) authorization: oauth2 + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_api = Dropbox::Sign::SignatureRequestApi.new + +signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signer_1.email_address = "jack@example.com" +signer_1.name = "Jack" +signer_1.order = 0 + +signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signer_2.email_address = "jill@example.com" +signer_2.name = "Jill" +signer_2.order = 1 + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.draw = true +signing_options.type = true +signing_options.upload = true +signing_options.phone = true +signing_options.default_type = "draw" + +data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +data.client_id = "ec64a202072370a737edf4a0eb7f4437" +data.title = "NDA with Acme Co." +data.subject = "The NDA we talked about" +data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." +data.signers = [signer_1, signer_2] +data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] +data.files = [File.new("example_signature_request.pdf", "r")] +data.signing_options = signing_options +data.test_mode = true + +signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + +begin + result = signature_request_api.signature_request_edit_embedded(signature_request_id, data) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `signature_request_edit_embedded_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request)` + +```ruby +begin + # Edit Embedded Signature Request + data, status_code, headers = api_instance.signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_request` | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + +## `signature_request_edit_embedded_with_template` + +> ` signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request)` + +Edit Embedded Signature Request with Template + +Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" + + # or, configure Bearer (JWT) authorization: oauth2 + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_api = Dropbox::Sign::SignatureRequestApi.new + +signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_1.role = "Client" +signer_1.email_address = "jack@example.com" +signer_1.name = "Jack" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.draw = true +signing_options.type = true +signing_options.upload = true +signing_options.phone = true +signing_options.default_type = "draw" + +data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new +data.client_id = "ec64a202072370a737edf4a0eb7f4437" +data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] +data.subject = "Purchase Order" +data.message = "Glad we could come to an agreement." +data.signers = [signer_1] +data.signing_options = signing_options +data.test_mode = true + +signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + +begin + result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `signature_request_edit_embedded_with_template_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request)` + +```ruby +begin + # Edit Embedded Signature Request with Template + data, status_code, headers = api_instance.signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_template_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_with_template_request` | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + +## `signature_request_edit_with_template` + +> ` signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request)` + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" + + # or, configure Bearer (JWT) authorization: oauth2 + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_api = Dropbox::Sign::SignatureRequestApi.new + +signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_1.role = "Client" +signer_1.email_address = "george@example.com" +signer_1.name = "George" + +cc_1 = Dropbox::Sign::SubCC.new +cc_1.role = "Accounting" +cc_1.email_address = "accounting@example.com" + +custom_field_1 = Dropbox::Sign::SubCustomField.new +custom_field_1.name = "Cost" +custom_field_1.value = "$20,000" +custom_field_1.editor = "Client" +custom_field_1.required = true + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.draw = true +signing_options.type = true +signing_options.upload = true +signing_options.phone = false +signing_options.default_type = "draw" + +data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new +data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] +data.subject = "Purchase Order" +data.message = "Glad we could come to an agreement." +data.signers = [signer_1] +data.ccs = [cc_1] +data.custom_fields = [custom_field_1] +data.signing_options = signing_options +data.test_mode = true + +signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + +begin + result = signature_request_api.signature_request_edit_with_template(signature_request_id, data) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `signature_request_edit_with_template_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request)` + +```ruby +begin + # Edit Signature Request With Template + data, status_code, headers = api_instance.signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_with_template_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_with_template_request` | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + ## `signature_request_files` > `File signature_request_files(signature_request_id, opts)` diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 000000000..383cd8e89 --- /dev/null +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,33 @@ +# Dropbox::Sign::SignatureRequestEditEmbeddedRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | +| `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```Array```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 000000000..736cbf786 --- /dev/null +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,24 @@ +# Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | + diff --git a/sdks/ruby/docs/SignatureRequestEditRequest.md b/sdks/ruby/docs/SignatureRequestEditRequest.md new file mode 100644 index 000000000..39d575aa3 --- /dev/null +++ b/sdks/ruby/docs/SignatureRequestEditRequest.md @@ -0,0 +1,34 @@ +# Dropbox::Sign::SignatureRequestEditRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | +| `client_id` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```Array```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | +| `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + diff --git a/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 000000000..12b4bee82 --- /dev/null +++ b/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,25 @@ +# Dropbox::Sign::SignatureRequestEditWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | + diff --git a/sdks/ruby/lib/dropbox-sign.rb b/sdks/ruby/lib/dropbox-sign.rb index 0921573f8..cd2a8b7ce 100644 --- a/sdks/ruby/lib/dropbox-sign.rb +++ b/sdks/ruby/lib/dropbox-sign.rb @@ -80,6 +80,10 @@ require 'dropbox-sign/models/signature_request_bulk_send_with_template_request' require 'dropbox-sign/models/signature_request_create_embedded_request' require 'dropbox-sign/models/signature_request_create_embedded_with_template_request' +require 'dropbox-sign/models/signature_request_edit_embedded_request' +require 'dropbox-sign/models/signature_request_edit_embedded_with_template_request' +require 'dropbox-sign/models/signature_request_edit_request' +require 'dropbox-sign/models/signature_request_edit_with_template_request' require 'dropbox-sign/models/signature_request_get_response' require 'dropbox-sign/models/signature_request_list_response' require 'dropbox-sign/models/signature_request_remind_request' diff --git a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb index d61d27b46..6698e776f 100644 --- a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb @@ -525,6 +525,466 @@ def signature_request_create_embedded_with_template_with_http_info(signature_req return data, status_code, headers end + # Edit Signature Request + # Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_request [SignatureRequestEditRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit(signature_request_id, signature_request_edit_request, opts = {}) + data, _status_code, _headers = signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request, opts) + data + end + + # Edit Signature Request + # Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_request [SignatureRequestEditRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit" + end + # verify the required parameter 'signature_request_edit_request' is set + if @api_client.config.client_side_validation && signature_request_edit_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_request' when calling SignatureRequestApi.signature_request_edit" + end + # resource path + local_var_path = '/signature_request/edit/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_request, + Dropbox::Sign::SignatureRequestEditRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edit Embedded Signature Request + # Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request, opts = {}) + data, _status_code, _headers = signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request, opts) + data + end + + # Edit Embedded Signature Request + # Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_embedded ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_embedded" + end + # verify the required parameter 'signature_request_edit_embedded_request' is set + if @api_client.config.client_side_validation && signature_request_edit_embedded_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_embedded_request' when calling SignatureRequestApi.signature_request_edit_embedded" + end + # resource path + local_var_path = '/signature_request/edit_embedded/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_embedded_request, + Dropbox::Sign::SignatureRequestEditEmbeddedRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit_embedded", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_embedded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edit Embedded Signature Request with Template + # Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request, opts = {}) + data, _status_code, _headers = signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request, opts) + data + end + + # Edit Embedded Signature Request with Template + # Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_embedded_with_template ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_embedded_with_template" + end + # verify the required parameter 'signature_request_edit_embedded_with_template_request' is set + if @api_client.config.client_side_validation && signature_request_edit_embedded_with_template_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_embedded_with_template_request' when calling SignatureRequestApi.signature_request_edit_embedded_with_template" + end + # resource path + local_var_path = '/signature_request/edit_embedded_with_template/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_embedded_with_template_request, + Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit_embedded_with_template", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edit Signature Request With Template + # Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request, opts = {}) + data, _status_code, _headers = signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request, opts) + data + end + + # Edit Signature Request With Template + # Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_with_template ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_with_template" + end + # verify the required parameter 'signature_request_edit_with_template_request' is set + if @api_client.config.client_side_validation && signature_request_edit_with_template_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_with_template_request' when calling SignatureRequestApi.signature_request_edit_with_template" + end + # resource path + local_var_path = '/signature_request/edit_with_template/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_with_template_request, + Dropbox::Sign::SignatureRequestEditWithTemplateRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit_with_template", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Download Files # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. # @param signature_request_id [String] The id of the SignatureRequest to retrieve. diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb new file mode 100644 index 000000000..266c043b9 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb @@ -0,0 +1,588 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class SignatureRequestEditEmbeddedRequest + # Client id of the app you're using to create this embedded signature request. Used for security purposes. + # @return [String] + attr_accessor :client_id + + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :signers + + # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :grouped_signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + # @return [Boolean] + attr_accessor :allow_reassign + + # A list describing the attachments + # @return [Array] + attr_accessor :attachments + + # The email addresses that should be CCed. + # @return [Array] + attr_accessor :cc_email_addresses + + # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + # @return [Array] + attr_accessor :custom_fields + + # @return [SubFieldOptions] + attr_accessor :field_options + + # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + # @return [Array] + attr_accessor :form_field_groups + + # Conditional Logic rules for fields defined in `form_fields_per_document`. + # @return [Array] + attr_accessor :form_field_rules + + # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + # @return [Array] + attr_accessor :form_fields_per_document + + # Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + # @return [Boolean] + attr_accessor :hide_text_tags + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + # @return [Boolean] + attr_accessor :use_text_tags + + # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + # @return [Boolean] + attr_accessor :populate_auto_fill_fields + + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + # @return [Integer, nil] + attr_accessor :expires_at + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'client_id' => :'client_id', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'signers' => :'signers', + :'grouped_signers' => :'grouped_signers', + :'allow_decline' => :'allow_decline', + :'allow_reassign' => :'allow_reassign', + :'attachments' => :'attachments', + :'cc_email_addresses' => :'cc_email_addresses', + :'custom_fields' => :'custom_fields', + :'field_options' => :'field_options', + :'form_field_groups' => :'form_field_groups', + :'form_field_rules' => :'form_field_rules', + :'form_fields_per_document' => :'form_fields_per_document', + :'hide_text_tags' => :'hide_text_tags', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title', + :'use_text_tags' => :'use_text_tags', + :'populate_auto_fill_fields' => :'populate_auto_fill_fields', + :'expires_at' => :'expires_at' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'client_id' => :'String', + :'files' => :'Array', + :'file_urls' => :'Array', + :'signers' => :'Array', + :'grouped_signers' => :'Array', + :'allow_decline' => :'Boolean', + :'allow_reassign' => :'Boolean', + :'attachments' => :'Array', + :'cc_email_addresses' => :'Array', + :'custom_fields' => :'Array', + :'field_options' => :'SubFieldOptions', + :'form_field_groups' => :'Array', + :'form_field_rules' => :'Array', + :'form_fields_per_document' => :'Array', + :'hide_text_tags' => :'Boolean', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String', + :'use_text_tags' => :'Boolean', + :'populate_auto_fill_fields' => :'Boolean', + :'expires_at' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'expires_at' + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditEmbeddedRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditEmbeddedRequest" + ) || SignatureRequestEditEmbeddedRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditEmbeddedRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'grouped_signers') + if (value = attributes[:'grouped_signers']).is_a?(Array) + self.grouped_signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'allow_reassign') + self.allow_reassign = attributes[:'allow_reassign'] + else + self.allow_reassign = false + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end + + if attributes.key?(:'cc_email_addresses') + if (value = attributes[:'cc_email_addresses']).is_a?(Array) + self.cc_email_addresses = value + end + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'field_options') + self.field_options = attributes[:'field_options'] + end + + if attributes.key?(:'form_field_groups') + if (value = attributes[:'form_field_groups']).is_a?(Array) + self.form_field_groups = value + end + end + + if attributes.key?(:'form_field_rules') + if (value = attributes[:'form_field_rules']).is_a?(Array) + self.form_field_rules = value + end + end + + if attributes.key?(:'form_fields_per_document') + if (value = attributes[:'form_fields_per_document']).is_a?(Array) + self.form_fields_per_document = value + end + end + + if attributes.key?(:'hide_text_tags') + self.hide_text_tags = attributes[:'hide_text_tags'] + else + self.hide_text_tags = false + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'use_text_tags') + self.use_text_tags = attributes[:'use_text_tags'] + else + self.use_text_tags = false + end + + if attributes.key?(:'populate_auto_fill_fields') + self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] + else + self.populate_auto_fill_fields = false + end + + if attributes.key?(:'expires_at') + self.expires_at = attributes[:'expires_at'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @client_id.nil? + invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') + end + + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @client_id.nil? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + client_id == o.client_id && + files == o.files && + file_urls == o.file_urls && + signers == o.signers && + grouped_signers == o.grouped_signers && + allow_decline == o.allow_decline && + allow_reassign == o.allow_reassign && + attachments == o.attachments && + cc_email_addresses == o.cc_email_addresses && + custom_fields == o.custom_fields && + field_options == o.field_options && + form_field_groups == o.form_field_groups && + form_field_rules == o.form_field_rules && + form_fields_per_document == o.form_fields_per_document && + hide_text_tags == o.hide_text_tags && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + subject == o.subject && + test_mode == o.test_mode && + title == o.title && + use_text_tags == o.use_text_tags && + populate_auto_fill_fields == o.populate_auto_fill_fields && + expires_at == o.expires_at + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb new file mode 100644 index 000000000..dfb0a6995 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb @@ -0,0 +1,485 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class SignatureRequestEditEmbeddedWithTemplateRequest + # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + # @return [Array] + attr_accessor :template_ids + + # Client id of the app you're using to create this embedded signature request. Used for security purposes. + # @return [String] + attr_accessor :client_id + + # Add Signers to your Templated-based Signature Request. + # @return [Array] + attr_accessor :signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Add CC email recipients. Required when a CC role exists for the Template. + # @return [Array] + attr_accessor :ccs + + # An array defining values and options for custom fields. Required when a custom field exists in the Template. + # @return [Array] + attr_accessor :custom_fields + + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. + # @return [Boolean] + attr_accessor :populate_auto_fill_fields + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'template_ids' => :'template_ids', + :'client_id' => :'client_id', + :'signers' => :'signers', + :'allow_decline' => :'allow_decline', + :'ccs' => :'ccs', + :'custom_fields' => :'custom_fields', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title', + :'populate_auto_fill_fields' => :'populate_auto_fill_fields' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'template_ids' => :'Array', + :'client_id' => :'String', + :'signers' => :'Array', + :'allow_decline' => :'Boolean', + :'ccs' => :'Array', + :'custom_fields' => :'Array', + :'files' => :'Array', + :'file_urls' => :'Array', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String', + :'populate_auto_fill_fields' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditEmbeddedWithTemplateRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ) || SignatureRequestEditEmbeddedWithTemplateRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'template_ids') + if (value = attributes[:'template_ids']).is_a?(Array) + self.template_ids = value + end + end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'ccs') + if (value = attributes[:'ccs']).is_a?(Array) + self.ccs = value + end + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'populate_auto_fill_fields') + self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] + else + self.populate_auto_fill_fields = false + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @template_ids.nil? + invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.') + end + + if @client_id.nil? + invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') + end + + if @signers.nil? + invalid_properties.push('invalid value for "signers", signers cannot be nil.') + end + + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @template_ids.nil? + return false if @client_id.nil? + return false if @signers.nil? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + template_ids == o.template_ids && + client_id == o.client_id && + signers == o.signers && + allow_decline == o.allow_decline && + ccs == o.ccs && + custom_fields == o.custom_fields && + files == o.files && + file_urls == o.file_urls && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + subject == o.subject && + test_mode == o.test_mode && + title == o.title && + populate_auto_fill_fields == o.populate_auto_fill_fields + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [template_ids, client_id, signers, allow_decline, ccs, custom_fields, files, file_urls, message, metadata, signing_options, subject, test_mode, title, populate_auto_fill_fields].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb new file mode 100644 index 000000000..20d933f92 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb @@ -0,0 +1,594 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class SignatureRequestEditRequest + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :signers + + # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :grouped_signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + # @return [Boolean] + attr_accessor :allow_reassign + + # A list describing the attachments + # @return [Array] + attr_accessor :attachments + + # The email addresses that should be CCed. + # @return [Array] + attr_accessor :cc_email_addresses + + # The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + # @return [String] + attr_accessor :client_id + + # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + # @return [Array] + attr_accessor :custom_fields + + # @return [SubFieldOptions] + attr_accessor :field_options + + # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + # @return [Array] + attr_accessor :form_field_groups + + # Conditional Logic rules for fields defined in `form_fields_per_document`. + # @return [Array] + attr_accessor :form_field_rules + + # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + # @return [Array] + attr_accessor :form_fields_per_document + + # Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + # @return [Boolean] + attr_accessor :hide_text_tags + + # Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + # @return [Boolean] + attr_accessor :is_eid + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The URL you want signers redirected to after they successfully sign. + # @return [String] + attr_accessor :signing_redirect_url + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + # @return [Boolean] + attr_accessor :use_text_tags + + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + # @return [Integer, nil] + attr_accessor :expires_at + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'files' => :'files', + :'file_urls' => :'file_urls', + :'signers' => :'signers', + :'grouped_signers' => :'grouped_signers', + :'allow_decline' => :'allow_decline', + :'allow_reassign' => :'allow_reassign', + :'attachments' => :'attachments', + :'cc_email_addresses' => :'cc_email_addresses', + :'client_id' => :'client_id', + :'custom_fields' => :'custom_fields', + :'field_options' => :'field_options', + :'form_field_groups' => :'form_field_groups', + :'form_field_rules' => :'form_field_rules', + :'form_fields_per_document' => :'form_fields_per_document', + :'hide_text_tags' => :'hide_text_tags', + :'is_eid' => :'is_eid', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'signing_redirect_url' => :'signing_redirect_url', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title', + :'use_text_tags' => :'use_text_tags', + :'expires_at' => :'expires_at' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'files' => :'Array', + :'file_urls' => :'Array', + :'signers' => :'Array', + :'grouped_signers' => :'Array', + :'allow_decline' => :'Boolean', + :'allow_reassign' => :'Boolean', + :'attachments' => :'Array', + :'cc_email_addresses' => :'Array', + :'client_id' => :'String', + :'custom_fields' => :'Array', + :'field_options' => :'SubFieldOptions', + :'form_field_groups' => :'Array', + :'form_field_rules' => :'Array', + :'form_fields_per_document' => :'Array', + :'hide_text_tags' => :'Boolean', + :'is_eid' => :'Boolean', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'signing_redirect_url' => :'String', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String', + :'use_text_tags' => :'Boolean', + :'expires_at' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'expires_at' + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditRequest" + ) || SignatureRequestEditRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'grouped_signers') + if (value = attributes[:'grouped_signers']).is_a?(Array) + self.grouped_signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'allow_reassign') + self.allow_reassign = attributes[:'allow_reassign'] + else + self.allow_reassign = false + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end + + if attributes.key?(:'cc_email_addresses') + if (value = attributes[:'cc_email_addresses']).is_a?(Array) + self.cc_email_addresses = value + end + end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'field_options') + self.field_options = attributes[:'field_options'] + end + + if attributes.key?(:'form_field_groups') + if (value = attributes[:'form_field_groups']).is_a?(Array) + self.form_field_groups = value + end + end + + if attributes.key?(:'form_field_rules') + if (value = attributes[:'form_field_rules']).is_a?(Array) + self.form_field_rules = value + end + end + + if attributes.key?(:'form_fields_per_document') + if (value = attributes[:'form_fields_per_document']).is_a?(Array) + self.form_fields_per_document = value + end + end + + if attributes.key?(:'hide_text_tags') + self.hide_text_tags = attributes[:'hide_text_tags'] + else + self.hide_text_tags = false + end + + if attributes.key?(:'is_eid') + self.is_eid = attributes[:'is_eid'] + else + self.is_eid = false + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'signing_redirect_url') + self.signing_redirect_url = attributes[:'signing_redirect_url'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'use_text_tags') + self.use_text_tags = attributes[:'use_text_tags'] + else + self.use_text_tags = false + end + + if attributes.key?(:'expires_at') + self.expires_at = attributes[:'expires_at'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + files == o.files && + file_urls == o.file_urls && + signers == o.signers && + grouped_signers == o.grouped_signers && + allow_decline == o.allow_decline && + allow_reassign == o.allow_reassign && + attachments == o.attachments && + cc_email_addresses == o.cc_email_addresses && + client_id == o.client_id && + custom_fields == o.custom_fields && + field_options == o.field_options && + form_field_groups == o.form_field_groups && + form_field_rules == o.form_field_rules && + form_fields_per_document == o.form_fields_per_document && + hide_text_tags == o.hide_text_tags && + is_eid == o.is_eid && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + signing_redirect_url == o.signing_redirect_url && + subject == o.subject && + test_mode == o.test_mode && + title == o.title && + use_text_tags == o.use_text_tags && + expires_at == o.expires_at + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb new file mode 100644 index 000000000..64a29f3ab --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb @@ -0,0 +1,492 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + # + class SignatureRequestEditWithTemplateRequest + # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + # @return [Array] + attr_accessor :template_ids + + # Add Signers to your Templated-based Signature Request. + # @return [Array] + attr_accessor :signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Add CC email recipients. Required when a CC role exists for the Template. + # @return [Array] + attr_accessor :ccs + + # Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + # @return [String] + attr_accessor :client_id + + # An array defining values and options for custom fields. Required when a custom field exists in the Template. + # @return [Array] + attr_accessor :custom_fields + + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + # @return [Boolean] + attr_accessor :is_eid + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The URL you want signers redirected to after they successfully sign. + # @return [String] + attr_accessor :signing_redirect_url + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'template_ids' => :'template_ids', + :'signers' => :'signers', + :'allow_decline' => :'allow_decline', + :'ccs' => :'ccs', + :'client_id' => :'client_id', + :'custom_fields' => :'custom_fields', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'is_eid' => :'is_eid', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'signing_redirect_url' => :'signing_redirect_url', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'template_ids' => :'Array', + :'signers' => :'Array', + :'allow_decline' => :'Boolean', + :'ccs' => :'Array', + :'client_id' => :'String', + :'custom_fields' => :'Array', + :'files' => :'Array', + :'file_urls' => :'Array', + :'is_eid' => :'Boolean', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'signing_redirect_url' => :'String', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditWithTemplateRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditWithTemplateRequest" + ) || SignatureRequestEditWithTemplateRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditWithTemplateRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'template_ids') + if (value = attributes[:'template_ids']).is_a?(Array) + self.template_ids = value + end + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'ccs') + if (value = attributes[:'ccs']).is_a?(Array) + self.ccs = value + end + end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'is_eid') + self.is_eid = attributes[:'is_eid'] + else + self.is_eid = false + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'signing_redirect_url') + self.signing_redirect_url = attributes[:'signing_redirect_url'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @template_ids.nil? + invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.') + end + + if @signers.nil? + invalid_properties.push('invalid value for "signers", signers cannot be nil.') + end + + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @template_ids.nil? + return false if @signers.nil? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + template_ids == o.template_ids && + signers == o.signers && + allow_decline == o.allow_decline && + ccs == o.ccs && + client_id == o.client_id && + custom_fields == o.custom_fields && + files == o.files && + file_urls == o.file_urls && + is_eid == o.is_eid && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + signing_redirect_url == o.signing_redirect_url && + subject == o.subject && + test_mode == o.test_mode && + title == o.title + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end From a8ae86867872c17aacf984e7dc462cb8db7b0aed Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Fri, 28 Feb 2025 16:21:01 -0600 Subject: [PATCH 06/16] Update examples and sandbox (#469) --- bin/sandbox-dotnet | 9 +- bin/{sandbox-java-v2 => sandbox-java} | 9 +- bin/sandbox-java-v1 | 25 - bin/sandbox-node | 22 +- bin/sandbox-php | 12 +- bin/sandbox-ruby | 32 + build | 7 + examples/AccountCreate.cs | 36 - examples/AccountCreate.java | 34 - examples/AccountCreate.js | 21 - examples/AccountCreate.php | 25 - examples/AccountCreate.rb | 21 - examples/AccountCreate.ts | 21 - examples/AccountCreateExample.cs | 39 + examples/AccountCreateExample.java | 43 + examples/AccountCreateExample.php | 25 + ...countCreate.py => AccountCreateExample.py} | 17 +- examples/AccountCreateExample.rb | 20 + ...countCreate.sh => AccountCreateExample.sh} | 0 examples/AccountCreateExample.ts | 19 + examples/AccountCreateOauthExample.cs | 41 + examples/AccountCreateOauthExample.java | 45 + examples/AccountCreateOauthExample.php | 27 + examples/AccountCreateOauthExample.py | 26 + examples/AccountCreateOauthExample.rb | 22 + examples/AccountCreateOauthExample.ts | 21 + examples/AccountGet.cs | 32 - examples/AccountGet.java | 31 - examples/AccountGet.js | 17 - examples/AccountGet.php | 22 - examples/AccountGet.rb | 18 - examples/AccountGet.ts | 17 - examples/AccountGetExample.cs | 33 + examples/AccountGetExample.java | 38 + examples/AccountGetExample.php | 20 + ...ineAreaCodeGet.py => AccountGetExample.py} | 13 +- examples/AccountGetExample.rb | 15 + .../{AccountGet.sh => AccountGetExample.sh} | 0 examples/AccountGetExample.ts | 14 + examples/AccountUpdate.cs | 36 - examples/AccountUpdate.java | 34 - examples/AccountUpdate.js | 21 - examples/AccountUpdate.php | 25 - examples/AccountUpdate.rb | 21 - examples/AccountUpdate.ts | 21 - examples/AccountUpdateExample.cs | 40 + examples/AccountUpdateExample.java | 44 + examples/AccountUpdateExample.php | 26 + ...countUpdate.py => AccountUpdateExample.py} | 18 +- examples/AccountUpdateExample.rb | 21 + ...countUpdate.sh => AccountUpdateExample.sh} | 0 examples/AccountUpdateExample.ts | 20 + examples/AccountVerify.cs | 36 - examples/AccountVerify.java | 34 - examples/AccountVerify.js | 21 - examples/AccountVerify.php | 25 - examples/AccountVerify.rb | 21 - examples/AccountVerify.ts | 21 - examples/AccountVerifyExample.cs | 39 + examples/AccountVerifyExample.java | 43 + examples/AccountVerifyExample.php | 25 + ...countVerify.py => AccountVerifyExample.py} | 17 +- examples/AccountVerifyExample.rb | 20 + ...countVerify.sh => AccountVerifyExample.sh} | 0 examples/AccountVerifyExample.ts | 19 + examples/ApiAppCreate.cs | 59 - examples/ApiAppCreate.java | 51 - examples/ApiAppCreate.js | 39 - examples/ApiAppCreate.php | 42 - examples/ApiAppCreate.rb | 35 - examples/ApiAppCreate.ts | 39 - examples/ApiAppCreateExample.cs | 61 + examples/ApiAppCreateExample.java | 60 + examples/ApiAppCreateExample.php | 42 + ...ApiAppCreate.py => ApiAppCreateExample.py} | 30 +- examples/ApiAppCreateExample.rb | 37 + ...ApiAppCreate.sh => ApiAppCreateExample.sh} | 0 examples/ApiAppCreateExample.ts | 36 + examples/ApiAppDelete.cs | 34 - examples/ApiAppDelete.java | 31 - examples/ApiAppDelete.js | 19 - examples/ApiAppDelete.php | 23 - examples/ApiAppDelete.py | 18 - examples/ApiAppDelete.rb | 20 - examples/ApiAppDelete.ts | 19 - examples/ApiAppDeleteExample.cs | 33 + examples/ApiAppDeleteExample.java | 38 + examples/ApiAppDeleteExample.php | 20 + examples/ApiAppDeleteExample.py | 18 + examples/ApiAppDeleteExample.rb | 15 + ...ApiAppDelete.sh => ApiAppDeleteExample.sh} | 0 examples/ApiAppDeleteExample.ts | 14 + examples/ApiAppGet.cs | 34 - examples/ApiAppGet.java | 33 - examples/ApiAppGet.js | 19 - examples/ApiAppGet.php | 24 - examples/ApiAppGet.py | 21 - examples/ApiAppGet.rb | 20 - examples/ApiAppGet.ts | 19 - examples/ApiAppGetExample.cs | 35 + examples/ApiAppGetExample.java | 40 + examples/ApiAppGetExample.php | 22 + .../{AccountGet.py => ApiAppGetExample.py} | 15 +- examples/ApiAppGetExample.rb | 17 + .../{ApiAppGet.sh => ApiAppGetExample.sh} | 0 examples/ApiAppGetExample.ts | 16 + examples/ApiAppList.cs | 35 - examples/ApiAppList.java | 34 - examples/ApiAppList.js | 20 - examples/ApiAppList.php | 25 - examples/ApiAppList.py | 25 - examples/ApiAppList.rb | 21 - examples/ApiAppList.ts | 20 - examples/ApiAppListExample.cs | 36 + examples/ApiAppListExample.java | 41 + examples/ApiAppListExample.php | 23 + examples/ApiAppListExample.py | 21 + examples/ApiAppListExample.rb | 20 + .../{ApiAppList.sh => ApiAppListExample.sh} | 0 examples/ApiAppListExample.ts | 17 + examples/ApiAppUpdate.cs | 61 - examples/ApiAppUpdate.java | 53 - examples/ApiAppUpdate.js | 32 - examples/ApiAppUpdate.php | 36 - examples/ApiAppUpdate.py | 35 - examples/ApiAppUpdate.rb | 32 - examples/ApiAppUpdate.ts | 32 - examples/ApiAppUpdateExample.cs | 63 + examples/ApiAppUpdateExample.java | 62 + examples/ApiAppUpdateExample.php | 44 + examples/ApiAppUpdateExample.py | 45 + examples/ApiAppUpdateExample.rb | 39 + ...ApiAppUpdate.sh => ApiAppUpdateExample.sh} | 0 examples/ApiAppUpdateExample.ts | 38 + examples/BulkSendJobGet.cs | 35 - examples/BulkSendJobGet.java | 33 - examples/BulkSendJobGet.js | 19 - examples/BulkSendJobGet.php | 24 - examples/BulkSendJobGet.py | 21 - examples/BulkSendJobGet.rb | 20 - examples/BulkSendJobGet.ts | 19 - examples/BulkSendJobGetExample.cs | 37 + examples/BulkSendJobGetExample.java | 42 + examples/BulkSendJobGetExample.php | 24 + examples/BulkSendJobGetExample.py | 22 + examples/BulkSendJobGetExample.rb | 21 + ...SendJobGet.sh => BulkSendJobGetExample.sh} | 0 examples/BulkSendJobGetExample.ts | 18 + examples/BulkSendJobList.cs | 36 - examples/BulkSendJobList.java | 34 - examples/BulkSendJobList.js | 20 - examples/BulkSendJobList.php | 25 - examples/BulkSendJobList.py | 25 - examples/BulkSendJobList.rb | 21 - examples/BulkSendJobList.ts | 20 - examples/BulkSendJobListExample.cs | 36 + examples/BulkSendJobListExample.java | 41 + examples/BulkSendJobListExample.php | 23 + examples/BulkSendJobListExample.py | 21 + examples/BulkSendJobListExample.rb | 20 + ...ndJobList.sh => BulkSendJobListExample.sh} | 0 examples/BulkSendJobListExample.ts | 17 + examples/EmbeddedEditUrl.cs | 40 - examples/EmbeddedEditUrl.java | 39 - examples/EmbeddedEditUrl.js | 24 - examples/EmbeddedEditUrl.php | 28 - examples/EmbeddedEditUrl.py | 26 - examples/EmbeddedEditUrl.rb | 24 - examples/EmbeddedEditUrl.ts | 24 - examples/EmbeddedEditUrlExample.cs | 45 + examples/EmbeddedEditUrlExample.java | 49 + examples/EmbeddedEditUrlExample.php | 32 + examples/EmbeddedEditUrlExample.py | 31 + examples/EmbeddedEditUrlExample.rb | 27 + ...edEditUrl.sh => EmbeddedEditUrlExample.sh} | 0 examples/EmbeddedEditUrlExample.ts | 26 + examples/EmbeddedSignUrl.cs | 35 - examples/EmbeddedSignUrl.java | 33 - examples/EmbeddedSignUrl.js | 19 - examples/EmbeddedSignUrl.php | 24 - examples/EmbeddedSignUrl.py | 21 - examples/EmbeddedSignUrl.rb | 20 - examples/EmbeddedSignUrl.ts | 19 - examples/EmbeddedSignUrlExample.cs | 35 + examples/EmbeddedSignUrlExample.java | 40 + examples/EmbeddedSignUrlExample.php | 22 + examples/EmbeddedSignUrlExample.py | 20 + examples/EmbeddedSignUrlExample.rb | 17 + ...edSignUrl.sh => EmbeddedSignUrlExample.sh} | 0 examples/EmbeddedSignUrlExample.ts | 16 + ...entCallback.cs => EventCallbackExample.cs} | 7 +- ...allback.java => EventCallbackExample.java} | 2 +- ...tCallback.php => EventCallbackExample.php} | 6 +- ...entCallback.py => EventCallbackExample.py} | 0 ...entCallback.rb => EventCallbackExample.rb} | 0 ...entCallback.js => EventCallbackExample.ts} | 0 examples/FaxDelete.java | 25 - examples/FaxDelete.js | 13 - examples/FaxDelete.php | 18 - examples/FaxDelete.py | 16 - examples/FaxDelete.rb | 14 - examples/FaxDelete.ts | 13 - .../{FaxLineDelete.cs => FaxDeleteExample.cs} | 20 +- examples/FaxDeleteExample.java | 37 + examples/FaxDeleteExample.php | 19 + examples/FaxDeleteExample.py | 17 + examples/FaxDeleteExample.rb | 14 + .../{FaxDelete.sh => FaxDeleteExample.sh} | 0 examples/FaxDeleteExample.ts | 13 + examples/FaxFiles.cs | 34 - examples/FaxFiles.java | 28 - examples/FaxFiles.js | 17 - examples/FaxFiles.php | 21 - examples/FaxFiles.py | 19 - examples/FaxFiles.rb | 17 - examples/FaxFiles.ts | 17 - examples/FaxFilesExample.cs | 36 + examples/FaxFilesExample.java | 38 + examples/FaxFilesExample.php | 21 + examples/FaxFilesExample.py | 19 + examples/FaxFilesExample.rb | 16 + examples/{FaxFiles.sh => FaxFilesExample.sh} | 0 examples/FaxFilesExample.ts | 15 + examples/FaxGet.cs | 31 - examples/FaxGet.java | 27 - examples/FaxGet.js | 16 - examples/FaxGet.php | 21 - examples/FaxGet.rb | 17 - examples/FaxGet.ts | 16 - examples/FaxGetExample.cs | 34 + examples/FaxGetExample.java | 39 + examples/FaxGetExample.php | 21 + examples/{FaxGet.py => FaxGetExample.py} | 16 +- examples/FaxGetExample.rb | 16 + examples/{FaxGet.sh => FaxGetExample.sh} | 0 examples/FaxGetExample.ts | 15 + examples/FaxLineAddUser.java | 30 - examples/FaxLineAddUser.js | 19 - examples/FaxLineAddUser.php | 23 - examples/FaxLineAddUser.rb | 19 - examples/FaxLineAddUser.ts | 19 - ...ineAddUser.cs => FaxLineAddUserExample.cs} | 21 +- examples/FaxLineAddUserExample.java | 43 + examples/FaxLineAddUserExample.php | 25 + ...RemoveUser.py => FaxLineAddUserExample.py} | 16 +- examples/FaxLineAddUserExample.rb | 20 + ...ineAddUser.sh => FaxLineAddUserExample.sh} | 0 examples/FaxLineAddUserExample.ts | 19 + examples/FaxLineAreaCodeGet.java | 26 - examples/FaxLineAreaCodeGet.js | 14 - examples/FaxLineAreaCodeGet.php | 19 - examples/FaxLineAreaCodeGet.rb | 15 - examples/FaxLineAreaCodeGet.ts | 14 - examples/FaxLineAreaCodeGetExample.cs | 37 + examples/FaxLineAreaCodeGetExample.java | 42 + examples/FaxLineAreaCodeGetExample.php | 24 + examples/FaxLineAreaCodeGetExample.py | 22 + examples/FaxLineAreaCodeGetExample.rb | 16 + ...odeGet.sh => FaxLineAreaCodeGetExample.sh} | 0 examples/FaxLineAreaCodeGetExample.ts | 18 + examples/FaxLineCreate.java | 30 - examples/FaxLineCreate.js | 19 - examples/FaxLineCreate.php | 23 - examples/FaxLineCreate.py | 22 - examples/FaxLineCreate.rb | 19 - examples/FaxLineCreate.ts | 19 - examples/FaxLineCreateExample.cs | 39 + examples/FaxLineCreateExample.java | 43 + examples/FaxLineCreateExample.php | 25 + examples/FaxLineCreateExample.py | 24 + examples/FaxLineCreateExample.rb | 20 + ...xLineCreate.sh => FaxLineCreateExample.sh} | 0 examples/FaxLineCreateExample.ts | 19 + examples/FaxLineDelete.java | 28 - examples/FaxLineDelete.js | 17 - examples/FaxLineDelete.php | 21 - examples/FaxLineDelete.py | 20 - examples/FaxLineDelete.rb | 17 - examples/FaxLineDelete.ts | 17 - examples/FaxLineDeleteExample.cs | 36 + examples/FaxLineDeleteExample.java | 40 + examples/FaxLineDeleteExample.php | 22 + examples/FaxLineDeleteExample.py | 21 + examples/FaxLineDeleteExample.rb | 17 + ...xLineDelete.sh => FaxLineDeleteExample.sh} | 0 examples/FaxLineDeleteExample.ts | 16 + examples/FaxLineGet.java | 26 - examples/FaxLineGet.js | 14 - examples/FaxLineGet.php | 19 - examples/FaxLineGet.rb | 15 - examples/FaxLineGet.ts | 14 - examples/FaxLineGetExample.cs | 34 + examples/FaxLineGetExample.java | 39 + examples/FaxLineGetExample.php | 21 + examples/FaxLineGetExample.py | 19 + examples/FaxLineGetExample.rb | 16 + .../{FaxLineGet.sh => FaxLineGetExample.sh} | 0 examples/FaxLineGetExample.ts | 15 + examples/FaxLineList.java | 26 - examples/FaxLineList.js | 14 - examples/FaxLineList.php | 19 - examples/FaxLineList.rb | 15 - examples/FaxLineList.ts | 14 - examples/FaxLineListExample.cs | 37 + examples/FaxLineListExample.java | 42 + examples/FaxLineListExample.php | 24 + examples/FaxLineListExample.py | 22 + examples/FaxLineListExample.rb | 21 + .../{FaxLineList.sh => FaxLineListExample.sh} | 0 examples/FaxLineListExample.ts | 18 + examples/FaxLineRemoveUser.java | 30 - examples/FaxLineRemoveUser.js | 19 - examples/FaxLineRemoveUser.php | 23 - examples/FaxLineRemoveUser.rb | 19 - examples/FaxLineRemoveUser.ts | 19 - examples/FaxLineRemoveUserExample.cs | 39 + examples/FaxLineRemoveUserExample.java | 43 + examples/FaxLineRemoveUserExample.php | 25 + examples/FaxLineRemoveUserExample.py | 24 + examples/FaxLineRemoveUserExample.rb | 20 + ...oveUser.sh => FaxLineRemoveUserExample.sh} | 0 examples/FaxLineRemoveUserExample.ts | 19 + examples/FaxList.cs | 32 - examples/FaxList.java | 28 - examples/FaxList.js | 17 - examples/FaxList.php | 22 - examples/FaxList.py | 23 - examples/FaxList.rb | 18 - examples/FaxList.ts | 17 - examples/FaxListExample.cs | 35 + examples/FaxListExample.java | 40 + examples/FaxListExample.php | 22 + examples/{FaxLineGet.py => FaxListExample.py} | 15 +- examples/FaxListExample.rb | 19 + examples/{FaxList.sh => FaxListExample.sh} | 0 examples/FaxListExample.ts | 16 + examples/FaxSend.java | 37 - examples/FaxSend.js | 47 - examples/FaxSend.php | 29 - examples/FaxSend.rb | 25 - examples/FaxSend.ts | 47 - examples/{FaxSend.cs => FaxSendExample.cs} | 42 +- examples/FaxSendExample.java | 51 + examples/FaxSendExample.php | 32 + examples/{FaxSend.py => FaxSendExample.py} | 24 +- examples/FaxSendExample.rb | 28 + examples/{FaxSend.sh => FaxSendExample.sh} | 0 examples/FaxSendExample.ts | 27 + examples/OauthTokenGenerate.cs | 35 - examples/OauthTokenGenerate.java | 30 - examples/OauthTokenGenerate.js | 17 - examples/OauthTokenGenerate.php | 22 - examples/OauthTokenGenerate.py | 21 - examples/OauthTokenGenerate.rb | 16 - examples/OauthTokenGenerate.ts | 17 - examples/OauthTokenGenerateExample.cs | 41 + examples/OauthTokenGenerateExample.java | 45 + examples/OauthTokenGenerateExample.php | 27 + examples/OauthTokenGenerateExample.py | 26 + examples/OauthTokenGenerateExample.rb | 22 + ...nerate.sh => OauthTokenGenerateExample.sh} | 0 examples/OauthTokenGenerateExample.ts | 21 + examples/OauthTokenRefresh.cs | 32 - examples/OauthTokenRefresh.java | 27 - examples/OauthTokenRefresh.js | 14 - examples/OauthTokenRefresh.php | 19 - examples/OauthTokenRefresh.py | 18 - examples/OauthTokenRefresh.rb | 13 - examples/OauthTokenRefresh.ts | 14 - examples/OauthTokenRefreshExample.cs | 38 + examples/OauthTokenRefreshExample.java | 42 + examples/OauthTokenRefreshExample.php | 24 + examples/OauthTokenRefreshExample.py | 23 + examples/OauthTokenRefreshExample.rb | 19 + ...Refresh.sh => OauthTokenRefreshExample.sh} | 0 examples/OauthTokenRefreshExample.ts | 18 + examples/ReportCreate.java | 41 - examples/ReportCreate.js | 23 - examples/ReportCreate.php | 27 - examples/ReportCreate.py | 25 - examples/ReportCreate.rb | 23 - examples/ReportCreate.ts | 23 - ...ReportCreate.cs => ReportCreateExample.cs} | 29 +- examples/ReportCreateExample.java | 47 + examples/ReportCreateExample.php | 29 + examples/ReportCreateExample.py | 28 + examples/ReportCreateExample.rb | 24 + ...ReportCreate.sh => ReportCreateExample.sh} | 0 examples/ReportCreateExample.ts | 23 + ...reRequestBulkCreateEmbeddedWithTemplate.cs | 82 - ...RequestBulkCreateEmbeddedWithTemplate.java | 73 - ...reRequestBulkCreateEmbeddedWithTemplate.js | 66 - ...eRequestBulkCreateEmbeddedWithTemplate.php | 60 - ...reRequestBulkCreateEmbeddedWithTemplate.py | 72 - ...reRequestBulkCreateEmbeddedWithTemplate.rb | 59 - ...reRequestBulkCreateEmbeddedWithTemplate.ts | 63 - ...stBulkCreateEmbeddedWithTemplateExample.cs | 116 + ...BulkCreateEmbeddedWithTemplateExample.java | 107 + ...tBulkCreateEmbeddedWithTemplateExample.php | 89 + ...stBulkCreateEmbeddedWithTemplateExample.py | 95 + ...stBulkCreateEmbeddedWithTemplateExample.rb | 84 + ...tBulkCreateEmbeddedWithTemplateExample.sh} | 0 ...stBulkCreateEmbeddedWithTemplateExample.ts | 83 + .../SignatureRequestBulkSendWithTemplate.cs | 81 - .../SignatureRequestBulkSendWithTemplate.java | 73 - .../SignatureRequestBulkSendWithTemplate.js | 65 - .../SignatureRequestBulkSendWithTemplate.php | 62 - .../SignatureRequestBulkSendWithTemplate.py | 67 - .../SignatureRequestBulkSendWithTemplate.rb | 58 - .../SignatureRequestBulkSendWithTemplate.ts | 65 - ...atureRequestBulkSendWithTemplateExample.cs | 116 + ...ureRequestBulkSendWithTemplateExample.java | 107 + ...tureRequestBulkSendWithTemplateExample.php | 89 + ...atureRequestBulkSendWithTemplateExample.py | 95 + ...atureRequestBulkSendWithTemplateExample.rb | 84 + ...tureRequestBulkSendWithTemplateExample.sh} | 0 ...atureRequestBulkSendWithTemplateExample.ts | 83 + examples/SignatureRequestCancel.cs | 34 - examples/SignatureRequestCancel.java | 31 - examples/SignatureRequestCancel.js | 19 - examples/SignatureRequestCancel.php | 23 - examples/SignatureRequestCancel.py | 18 - examples/SignatureRequestCancel.rb | 20 - examples/SignatureRequestCancel.ts | 19 - examples/SignatureRequestCancelExample.cs | 33 + examples/SignatureRequestCancelExample.java | 38 + examples/SignatureRequestCancelExample.php | 20 + examples/SignatureRequestCancelExample.py | 18 + examples/SignatureRequestCancelExample.rb | 15 + ...el.sh => SignatureRequestCancelExample.sh} | 0 examples/SignatureRequestCancelExample.ts | 14 + examples/SignatureRequestCreateEmbedded.cs | 74 - examples/SignatureRequestCreateEmbedded.java | 62 - examples/SignatureRequestCreateEmbedded.js | 53 - examples/SignatureRequestCreateEmbedded.php | 53 - examples/SignatureRequestCreateEmbedded.py | 51 - examples/SignatureRequestCreateEmbedded.rb | 46 - examples/SignatureRequestCreateEmbedded.ts | 53 - .../SignatureRequestCreateEmbeddedExample.cs | 82 + ...SignatureRequestCreateEmbeddedExample.java | 78 + .../SignatureRequestCreateEmbeddedExample.php | 59 + .../SignatureRequestCreateEmbeddedExample.py | 62 + .../SignatureRequestCreateEmbeddedExample.rb | 55 + ... SignatureRequestCreateEmbeddedExample.sh} | 0 .../SignatureRequestCreateEmbeddedExample.ts | 54 + ...uestCreateEmbeddedGroupedSignersExample.cs | 110 + ...stCreateEmbeddedGroupedSignersExample.java | 104 + ...estCreateEmbeddedGroupedSignersExample.php | 86 + ...uestCreateEmbeddedGroupedSignersExample.py | 92 + ...uestCreateEmbeddedGroupedSignersExample.rb | 81 + ...uestCreateEmbeddedGroupedSignersExample.ts | 80 + ...natureRequestCreateEmbeddedWithTemplate.cs | 55 - ...tureRequestCreateEmbeddedWithTemplate.java | 53 - ...natureRequestCreateEmbeddedWithTemplate.js | 41 - ...atureRequestCreateEmbeddedWithTemplate.php | 43 - ...natureRequestCreateEmbeddedWithTemplate.py | 45 - ...natureRequestCreateEmbeddedWithTemplate.rb | 39 - ...natureRequestCreateEmbeddedWithTemplate.ts | 41 - ...equestCreateEmbeddedWithTemplateExample.cs | 66 + ...uestCreateEmbeddedWithTemplateExample.java | 67 + ...questCreateEmbeddedWithTemplateExample.php | 49 + ...equestCreateEmbeddedWithTemplateExample.py | 50 + ...equestCreateEmbeddedWithTemplateExample.rb | 44 + ...questCreateEmbeddedWithTemplateExample.sh} | 0 ...equestCreateEmbeddedWithTemplateExample.ts | 43 + examples/SignatureRequestEdit.cs | 87 - examples/SignatureRequestEdit.java | 69 - examples/SignatureRequestEdit.js | 84 - examples/SignatureRequestEdit.php | 62 - examples/SignatureRequestEdit.rb | 58 - examples/SignatureRequestEdit.ts | 85 - examples/SignatureRequestEditEmbedded.cs | 79 - examples/SignatureRequestEditEmbedded.java | 67 - examples/SignatureRequestEditEmbedded.js | 58 - examples/SignatureRequestEditEmbedded.php | 58 - examples/SignatureRequestEditEmbedded.py | 55 - examples/SignatureRequestEditEmbedded.rb | 48 - examples/SignatureRequestEditEmbedded.ts | 58 - .../SignatureRequestEditEmbeddedExample.cs | 83 + .../SignatureRequestEditEmbeddedExample.java | 79 + .../SignatureRequestEditEmbeddedExample.php | 60 + .../SignatureRequestEditEmbeddedExample.py | 63 + .../SignatureRequestEditEmbeddedExample.rb | 56 + ...=> SignatureRequestEditEmbeddedExample.sh} | 0 .../SignatureRequestEditEmbeddedExample.ts | 55 + ...equestEditEmbeddedGroupedSignersExample.cs | 111 + ...uestEditEmbeddedGroupedSignersExample.java | 105 + ...questEditEmbeddedGroupedSignersExample.php | 87 + ...equestEditEmbeddedGroupedSignersExample.py | 93 + ...equestEditEmbeddedGroupedSignersExample.rb | 82 + ...equestEditEmbeddedGroupedSignersExample.ts | 81 + ...ignatureRequestEditEmbeddedWithTemplate.cs | 60 - ...natureRequestEditEmbeddedWithTemplate.java | 58 - ...ignatureRequestEditEmbeddedWithTemplate.js | 46 - ...gnatureRequestEditEmbeddedWithTemplate.php | 48 - ...ignatureRequestEditEmbeddedWithTemplate.py | 47 - ...ignatureRequestEditEmbeddedWithTemplate.rb | 41 - ...ignatureRequestEditEmbeddedWithTemplate.ts | 46 - ...eRequestEditEmbeddedWithTemplateExample.cs | 67 + ...equestEditEmbeddedWithTemplateExample.java | 68 + ...RequestEditEmbeddedWithTemplateExample.php | 50 + ...eRequestEditEmbeddedWithTemplateExample.py | 51 + ...eRequestEditEmbeddedWithTemplateExample.rb | 45 + ...RequestEditEmbeddedWithTemplateExample.sh} | 0 ...eRequestEditEmbeddedWithTemplateExample.ts | 44 + examples/SignatureRequestEditExample.cs | 93 + examples/SignatureRequestEditExample.java | 88 + examples/SignatureRequestEditExample.php | 69 + ...eate.py => SignatureRequestEditExample.py} | 75 +- examples/SignatureRequestEditExample.rb | 66 + ...Edit.sh => SignatureRequestEditExample.sh} | 0 examples/SignatureRequestEditExample.ts | 62 + ...gnatureRequestEditGroupedSignersExample.cs | 121 + ...atureRequestEditGroupedSignersExample.java | 114 + ...natureRequestEditGroupedSignersExample.php | 96 + ...gnatureRequestEditGroupedSignersExample.py | 103 + ...gnatureRequestEditGroupedSignersExample.rb | 92 + ...gnatureRequestEditGroupedSignersExample.ts | 88 + examples/SignatureRequestEditWithTemplate.cs | 71 - .../SignatureRequestEditWithTemplate.java | 70 - examples/SignatureRequestEditWithTemplate.js | 59 - examples/SignatureRequestEditWithTemplate.php | 56 - examples/SignatureRequestEditWithTemplate.rb | 52 - examples/SignatureRequestEditWithTemplate.ts | 59 - ...SignatureRequestEditWithTemplateExample.cs | 90 + ...gnatureRequestEditWithTemplateExample.java | 87 + ...ignatureRequestEditWithTemplateExample.php | 69 + ...SignatureRequestEditWithTemplateExample.py | 72 + ...SignatureRequestEditWithTemplateExample.rb | 64 + ...ignatureRequestEditWithTemplateExample.sh} | 0 ...SignatureRequestEditWithTemplateExample.ts | 63 + examples/SignatureRequestFiles.cs | 38 - examples/SignatureRequestFiles.java | 34 - examples/SignatureRequestFiles.js | 22 - examples/SignatureRequestFiles.php | 25 - examples/SignatureRequestFiles.py | 23 - examples/SignatureRequestFiles.rb | 20 - examples/SignatureRequestFiles.ts | 22 - examples/SignatureRequestFilesAsDataUri.cs | 34 - examples/SignatureRequestFilesAsDataUri.java | 33 - examples/SignatureRequestFilesAsDataUri.js | 19 - examples/SignatureRequestFilesAsDataUri.php | 24 - examples/SignatureRequestFilesAsDataUri.py | 23 - examples/SignatureRequestFilesAsDataUri.rb | 20 - examples/SignatureRequestFilesAsDataUri.ts | 19 - .../SignatureRequestFilesAsDataUriExample.cs | 35 + ...SignatureRequestFilesAsDataUriExample.java | 40 + .../SignatureRequestFilesAsDataUriExample.php | 22 + .../SignatureRequestFilesAsDataUriExample.py | 20 + .../SignatureRequestFilesAsDataUriExample.rb | 17 + ... SignatureRequestFilesAsDataUriExample.sh} | 0 .../SignatureRequestFilesAsDataUriExample.ts | 16 + examples/SignatureRequestFilesAsFileUrl.cs | 34 - examples/SignatureRequestFilesAsFileUrl.java | 33 - examples/SignatureRequestFilesAsFileUrl.js | 19 - examples/SignatureRequestFilesAsFileUrl.php | 24 - examples/SignatureRequestFilesAsFileUrl.py | 23 - examples/SignatureRequestFilesAsFileUrl.rb | 20 - examples/SignatureRequestFilesAsFileUrl.ts | 19 - .../SignatureRequestFilesAsFileUrlExample.cs | 36 + ...SignatureRequestFilesAsFileUrlExample.java | 41 + .../SignatureRequestFilesAsFileUrlExample.php | 23 + .../SignatureRequestFilesAsFileUrlExample.py | 21 + .../SignatureRequestFilesAsFileUrlExample.rb | 20 + ... SignatureRequestFilesAsFileUrlExample.sh} | 0 .../SignatureRequestFilesAsFileUrlExample.ts | 17 + examples/SignatureRequestFilesExample.cs | 38 + examples/SignatureRequestFilesExample.java | 40 + examples/SignatureRequestFilesExample.php | 23 + examples/SignatureRequestFilesExample.py | 21 + examples/SignatureRequestFilesExample.rb | 20 + ...les.sh => SignatureRequestFilesExample.sh} | 0 examples/SignatureRequestFilesExample.ts | 17 + examples/SignatureRequestGet.cs | 34 - examples/SignatureRequestGet.java | 33 - examples/SignatureRequestGet.js | 19 - examples/SignatureRequestGet.php | 24 - examples/SignatureRequestGet.py | 21 - examples/SignatureRequestGet.rb | 20 - examples/SignatureRequestGet.ts | 19 - examples/SignatureRequestGetExample.cs | 35 + examples/SignatureRequestGetExample.java | 40 + examples/SignatureRequestGetExample.php | 22 + examples/SignatureRequestGetExample.py | 20 + examples/SignatureRequestGetExample.rb | 17 + ...stGet.sh => SignatureRequestGetExample.sh} | 0 examples/SignatureRequestGetExample.ts | 16 + examples/SignatureRequestList.cs | 34 - examples/SignatureRequestList.java | 41 - examples/SignatureRequestList.js | 20 - examples/SignatureRequestList.php | 25 - examples/SignatureRequestList.py | 25 - examples/SignatureRequestList.rb | 21 - examples/SignatureRequestList.ts | 20 - examples/SignatureRequestListExample.cs | 38 + examples/SignatureRequestListExample.java | 43 + examples/SignatureRequestListExample.php | 25 + examples/SignatureRequestListExample.py | 23 + examples/SignatureRequestListExample.rb | 22 + ...List.sh => SignatureRequestListExample.sh} | 0 examples/SignatureRequestListExample.ts | 19 + examples/SignatureRequestReleaseHold.cs | 34 - examples/SignatureRequestReleaseHold.java | 33 - examples/SignatureRequestReleaseHold.js | 19 - examples/SignatureRequestReleaseHold.php | 24 - examples/SignatureRequestReleaseHold.py | 23 - examples/SignatureRequestReleaseHold.rb | 20 - examples/SignatureRequestReleaseHold.ts | 19 - .../SignatureRequestReleaseHoldExample.cs | 35 + .../SignatureRequestReleaseHoldExample.java | 40 + .../SignatureRequestReleaseHoldExample.php | 22 + .../SignatureRequestReleaseHoldExample.py | 20 + .../SignatureRequestReleaseHoldExample.rb | 17 + ... => SignatureRequestReleaseHoldExample.sh} | 0 .../SignatureRequestReleaseHoldExample.ts | 16 + examples/SignatureRequestRemind.cs | 38 - examples/SignatureRequestRemind.java | 36 - examples/SignatureRequestRemind.js | 23 - examples/SignatureRequestRemind.php | 27 - examples/SignatureRequestRemind.py | 27 - examples/SignatureRequestRemind.rb | 23 - examples/SignatureRequestRemind.ts | 23 - examples/SignatureRequestRemindExample.cs | 40 + examples/SignatureRequestRemindExample.java | 44 + examples/SignatureRequestRemindExample.php | 26 + examples/SignatureRequestRemindExample.py | 25 + examples/SignatureRequestRemindExample.rb | 21 + ...nd.sh => SignatureRequestRemindExample.sh} | 0 examples/SignatureRequestRemindExample.ts | 20 + examples/SignatureRequestRemove.cs | 33 - examples/SignatureRequestRemove.java | 31 - examples/SignatureRequestRemove.js | 19 - examples/SignatureRequestRemove.php | 20 - examples/SignatureRequestRemove.py | 18 - examples/SignatureRequestRemove.rb | 20 - examples/SignatureRequestRemove.ts | 19 - ...te.cs => SignatureRequestRemoveExample.cs} | 22 +- examples/SignatureRequestRemoveExample.java | 37 + examples/SignatureRequestRemoveExample.php | 19 + examples/SignatureRequestRemoveExample.py | 17 + examples/SignatureRequestRemoveExample.rb | 14 + ...ve.sh => SignatureRequestRemoveExample.sh} | 0 examples/SignatureRequestRemoveExample.ts | 13 + examples/SignatureRequestSend.cs | 85 - examples/SignatureRequestSend.java | 67 - examples/SignatureRequestSend.js | 82 - examples/SignatureRequestSend.php | 60 - examples/SignatureRequestSend.rb | 56 - examples/SignatureRequestSend.ts | 82 - examples/SignatureRequestSendExample.cs | 92 + examples/SignatureRequestSendExample.java | 87 + examples/SignatureRequestSendExample.php | 68 + ...Edit.py => SignatureRequestSendExample.py} | 76 +- examples/SignatureRequestSendExample.rb | 65 + ...Send.sh => SignatureRequestSendExample.sh} | 0 examples/SignatureRequestSendExample.ts | 61 + ...gnatureRequestSendGroupedSignersExample.cs | 120 + ...atureRequestSendGroupedSignersExample.java | 113 + ...natureRequestSendGroupedSignersExample.php | 95 + ...gnatureRequestSendGroupedSignersExample.py | 102 + ...gnatureRequestSendGroupedSignersExample.rb | 91 + ...gnatureRequestSendGroupedSignersExample.ts | 87 + examples/SignatureRequestSendWithTemplate.cs | 69 - .../SignatureRequestSendWithTemplate.java | 65 - examples/SignatureRequestSendWithTemplate.js | 54 - examples/SignatureRequestSendWithTemplate.php | 54 - examples/SignatureRequestSendWithTemplate.rb | 50 - examples/SignatureRequestSendWithTemplate.ts | 54 - ...SignatureRequestSendWithTemplateExample.cs | 89 + ...gnatureRequestSendWithTemplateExample.java | 86 + ...ignatureRequestSendWithTemplateExample.php | 68 + ...ignatureRequestSendWithTemplateExample.py} | 67 +- ...SignatureRequestSendWithTemplateExample.rb | 63 + ...ignatureRequestSendWithTemplateExample.sh} | 0 ...SignatureRequestSendWithTemplateExample.ts | 62 + examples/SignatureRequestUpdate.cs | 39 - examples/SignatureRequestUpdate.java | 37 - examples/SignatureRequestUpdate.js | 24 - examples/SignatureRequestUpdate.php | 28 - examples/SignatureRequestUpdate.py | 28 - examples/SignatureRequestUpdate.rb | 24 - examples/SignatureRequestUpdate.ts | 24 - examples/SignatureRequestUpdateExample.cs | 41 + examples/SignatureRequestUpdateExample.java | 45 + examples/SignatureRequestUpdateExample.php | 27 + examples/SignatureRequestUpdateExample.py | 26 + examples/SignatureRequestUpdateExample.rb | 22 + ...te.sh => SignatureRequestUpdateExample.sh} | 0 examples/SignatureRequestUpdateExample.ts | 21 + examples/TeamAddMember.cs | 36 - examples/TeamAddMember.java | 36 - examples/TeamAddMember.js | 21 - examples/TeamAddMember.php | 25 - examples/TeamAddMember.py | 23 - examples/TeamAddMember.rb | 21 - examples/TeamAddMember.ts | 21 - examples/TeamAddMemberAccountIdExample.cs | 40 + examples/TeamAddMemberAccountIdExample.java | 44 + examples/TeamAddMemberAccountIdExample.php | 26 + examples/TeamAddMemberAccountIdExample.py | 25 + examples/TeamAddMemberAccountIdExample.rb | 23 + examples/TeamAddMemberAccountIdExample.ts | 20 + examples/TeamAddMemberExample.cs | 40 + examples/TeamAddMemberExample.java | 44 + examples/TeamAddMemberExample.php | 26 + examples/TeamAddMemberExample.py | 25 + examples/TeamAddMemberExample.rb | 23 + ...amAddMember.sh => TeamAddMemberExample.sh} | 0 examples/TeamAddMemberExample.ts | 20 + examples/TeamCreate.cs | 36 - examples/TeamCreate.java | 34 - examples/TeamCreate.js | 21 - examples/TeamCreate.php | 25 - examples/TeamCreate.rb | 21 - examples/TeamCreate.ts | 21 - examples/TeamCreateExample.cs | 39 + examples/TeamCreateExample.java | 43 + examples/TeamCreateExample.php | 25 + .../{TeamUpdate.py => TeamCreateExample.py} | 17 +- examples/TeamCreateExample.rb | 20 + .../{TeamCreate.sh => TeamCreateExample.sh} | 0 examples/TeamCreateExample.ts | 19 + examples/TeamDelete.cs | 31 - examples/TeamDelete.java | 29 - examples/TeamDelete.js | 17 - examples/TeamDelete.php | 21 - examples/TeamDelete.rb | 18 - examples/TeamDelete.ts | 17 - .../{FaxDelete.cs => TeamDeleteExample.cs} | 15 +- examples/TeamDeleteExample.java | 36 + examples/TeamDeleteExample.php | 18 + .../{TeamDelete.py => TeamDeleteExample.py} | 14 +- examples/TeamDeleteExample.rb | 13 + .../{TeamDelete.sh => TeamDeleteExample.sh} | 0 examples/TeamDeleteExample.ts | 12 + examples/TeamGet.cs | 32 - examples/TeamGet.java | 31 - examples/TeamGet.js | 17 - examples/TeamGet.php | 22 - examples/TeamGet.rb | 18 - examples/TeamGet.ts | 17 - ...axLineAreaCodeGet.cs => TeamGetExample.cs} | 18 +- examples/TeamGetExample.java | 38 + examples/TeamGetExample.php | 20 + examples/{TeamGet.py => TeamGetExample.py} | 13 +- examples/TeamGetExample.rb | 15 + examples/{TeamGet.sh => TeamGetExample.sh} | 0 examples/TeamGetExample.ts | 14 + examples/TeamInfo.cs | 32 - examples/TeamInfo.java | 31 - examples/TeamInfo.js | 17 - examples/TeamInfo.php | 22 - examples/TeamInfo.rb | 18 - examples/TeamInfo.ts | 17 - examples/TeamInfoExample.cs | 35 + examples/TeamInfoExample.java | 40 + examples/TeamInfoExample.php | 22 + examples/TeamInfoExample.py | 20 + examples/TeamInfoExample.rb | 19 + examples/{TeamInfo.sh => TeamInfoExample.sh} | 0 examples/TeamInfoExample.ts | 16 + examples/TeamInvites.cs | 33 - examples/TeamInvites.java | 33 - examples/TeamInvites.js | 19 - examples/TeamInvites.php | 24 - examples/TeamInvites.py | 21 - examples/TeamInvites.rb | 20 - examples/TeamInvites.ts | 19 - examples/TeamInvitesExample.cs | 33 + examples/TeamInvitesExample.java | 38 + examples/TeamInvitesExample.php | 20 + .../{FaxLineList.py => TeamInvitesExample.py} | 13 +- examples/TeamInvitesExample.rb | 15 + .../{TeamInvites.sh => TeamInvitesExample.sh} | 0 examples/TeamInvitesExample.ts | 14 + examples/TeamMembers.cs | 33 - examples/TeamMembers.java | 35 - examples/TeamMembers.js | 19 - examples/TeamMembers.php | 24 - examples/TeamMembers.py | 21 - examples/TeamMembers.rb | 20 - examples/TeamMembers.ts | 19 - examples/TeamMembersExample.cs | 37 + examples/TeamMembersExample.java | 42 + examples/TeamMembersExample.php | 24 + examples/TeamMembersExample.py | 22 + examples/TeamMembersExample.rb | 21 + .../{TeamMembers.sh => TeamMembersExample.sh} | 0 examples/TeamMembersExample.ts | 18 + examples/TeamRemoveMember.java | 35 - examples/TeamRemoveMember.js | 22 - examples/TeamRemoveMember.php | 26 - examples/TeamRemoveMember.rb | 22 - examples/TeamRemoveMember.ts | 22 - examples/TeamRemoveMemberAccountIdExample.cs | 39 + .../TeamRemoveMemberAccountIdExample.java | 43 + examples/TeamRemoveMemberAccountIdExample.php | 25 + examples/TeamRemoveMemberAccountIdExample.py | 24 + examples/TeamRemoveMemberAccountIdExample.rb | 20 + examples/TeamRemoveMemberAccountIdExample.ts | 19 + ...veMember.cs => TeamRemoveMemberExample.cs} | 27 +- examples/TeamRemoveMemberExample.java | 44 + examples/TeamRemoveMemberExample.php | 26 + ...veMember.py => TeamRemoveMemberExample.py} | 17 +- examples/TeamRemoveMemberExample.rb | 21 + ...veMember.sh => TeamRemoveMemberExample.sh} | 0 examples/TeamRemoveMemberExample.ts | 20 + examples/TeamSubTeams.cs | 33 - examples/TeamSubTeams.java | 35 - examples/TeamSubTeams.js | 19 - examples/TeamSubTeams.php | 24 - examples/TeamSubTeams.py | 21 - examples/TeamSubTeams.rb | 20 - examples/TeamSubTeams.ts | 19 - examples/TeamSubTeamsExample.cs | 37 + examples/TeamSubTeamsExample.java | 42 + examples/TeamSubTeamsExample.php | 24 + examples/TeamSubTeamsExample.py | 22 + examples/TeamSubTeamsExample.rb | 21 + ...TeamSubTeams.sh => TeamSubTeamsExample.sh} | 0 examples/TeamSubTeamsExample.ts | 18 + examples/TeamUpdate.cs | 36 - examples/TeamUpdate.java | 34 - examples/TeamUpdate.js | 21 - examples/TeamUpdate.php | 25 - examples/TeamUpdate.rb | 21 - examples/TeamUpdate.ts | 21 - examples/TeamUpdateExample.cs | 39 + examples/TeamUpdateExample.java | 43 + examples/TeamUpdateExample.php | 25 + .../{TeamCreate.py => TeamUpdateExample.py} | 17 +- examples/TeamUpdateExample.rb | 20 + .../{TeamUpdate.sh => TeamUpdateExample.sh} | 0 examples/TeamUpdateExample.ts | 19 + examples/TemplateAddUser.cs | 38 - examples/TemplateAddUser.java | 36 - examples/TemplateAddUser.js | 23 - examples/TemplateAddUser.php | 27 - examples/TemplateAddUser.py | 25 - examples/TemplateAddUser.rb | 23 - examples/TemplateAddUser.ts | 23 - examples/TemplateAddUserExample.cs | 40 + examples/TemplateAddUserExample.java | 44 + examples/TemplateAddUserExample.php | 26 + examples/TemplateAddUserExample.py | 25 + examples/TemplateAddUserExample.rb | 21 + ...teAddUser.sh => TemplateAddUserExample.sh} | 0 examples/TemplateAddUserExample.ts | 20 + examples/TemplateCreate.cs | 79 - examples/TemplateCreate.java | 65 - examples/TemplateCreate.js | 61 - examples/TemplateCreate.php | 53 - examples/TemplateCreate.py | 56 - examples/TemplateCreate.rb | 49 - examples/TemplateCreate.ts | 61 - examples/TemplateCreateEmbeddedDraft.cs | 79 - examples/TemplateCreateEmbeddedDraft.java | 65 - examples/TemplateCreateEmbeddedDraft.js | 61 - examples/TemplateCreateEmbeddedDraft.php | 53 - examples/TemplateCreateEmbeddedDraft.py | 56 - examples/TemplateCreateEmbeddedDraft.rb | 49 - examples/TemplateCreateEmbeddedDraft.ts | 61 - .../TemplateCreateEmbeddedDraftExample.cs | 92 + .../TemplateCreateEmbeddedDraftExample.java | 85 + .../TemplateCreateEmbeddedDraftExample.php | 66 + .../TemplateCreateEmbeddedDraftExample.py | 71 + .../TemplateCreateEmbeddedDraftExample.rb | 62 + ... => TemplateCreateEmbeddedDraftExample.sh} | 0 .../TemplateCreateEmbeddedDraftExample.ts | 61 + ...eateEmbeddedDraftFormFieldGroupsExample.cs | 139 + ...teEmbeddedDraftFormFieldGroupsExample.java | 131 + ...ateEmbeddedDraftFormFieldGroupsExample.php | 113 + ...eateEmbeddedDraftFormFieldGroupsExample.py | 120 + ...eateEmbeddedDraftFormFieldGroupsExample.rb | 108 + ...eateEmbeddedDraftFormFieldGroupsExample.ts | 107 + ...reateEmbeddedDraftFormFieldRulesExample.cs | 159 + ...ateEmbeddedDraftFormFieldRulesExample.java | 147 + ...eateEmbeddedDraftFormFieldRulesExample.php | 129 + ...reateEmbeddedDraftFormFieldRulesExample.py | 138 + ...reateEmbeddedDraftFormFieldRulesExample.rb | 124 + ...reateEmbeddedDraftFormFieldRulesExample.ts | 123 + ...beddedDraftFormFieldsPerDocumentExample.cs | 125 + ...ddedDraftFormFieldsPerDocumentExample.java | 119 + ...eddedDraftFormFieldsPerDocumentExample.php | 101 + ...beddedDraftFormFieldsPerDocumentExample.py | 107 + ...beddedDraftFormFieldsPerDocumentExample.rb | 96 + ...beddedDraftFormFieldsPerDocumentExample.ts | 95 + examples/TemplateCreateExample.cs | 129 + examples/TemplateCreateExample.java | 119 + examples/TemplateCreateExample.php | 100 + examples/TemplateCreateExample.py | 107 + examples/TemplateCreateExample.rb | 96 + ...lateCreate.sh => TemplateCreateExample.sh} | 0 examples/TemplateCreateExample.ts | 95 + .../TemplateCreateFormFieldGroupsExample.cs | 139 + .../TemplateCreateFormFieldGroupsExample.java | 131 + .../TemplateCreateFormFieldGroupsExample.php | 113 + .../TemplateCreateFormFieldGroupsExample.py | 120 + .../TemplateCreateFormFieldGroupsExample.rb | 108 + .../TemplateCreateFormFieldGroupsExample.ts | 107 + .../TemplateCreateFormFieldRulesExample.cs | 159 + .../TemplateCreateFormFieldRulesExample.java | 147 + .../TemplateCreateFormFieldRulesExample.php | 129 + .../TemplateCreateFormFieldRulesExample.py | 138 + .../TemplateCreateFormFieldRulesExample.rb | 124 + .../TemplateCreateFormFieldRulesExample.ts | 123 + ...plateCreateFormFieldsPerDocumentExample.cs | 125 + ...ateCreateFormFieldsPerDocumentExample.java | 119 + ...lateCreateFormFieldsPerDocumentExample.php | 101 + ...plateCreateFormFieldsPerDocumentExample.py | 107 + ...plateCreateFormFieldsPerDocumentExample.rb | 96 + ...plateCreateFormFieldsPerDocumentExample.ts | 95 + examples/TemplateDelete.cs | 33 - examples/TemplateDelete.java | 31 - examples/TemplateDelete.js | 19 - examples/TemplateDelete.php | 23 - examples/TemplateDelete.py | 18 - examples/TemplateDelete.rb | 20 - examples/TemplateDelete.ts | 19 - examples/TemplateDeleteExample.cs | 33 + examples/TemplateDeleteExample.java | 38 + examples/TemplateDeleteExample.php | 20 + examples/TemplateDeleteExample.py | 18 + examples/TemplateDeleteExample.rb | 15 + ...lateDelete.sh => TemplateDeleteExample.sh} | 0 examples/TemplateDeleteExample.ts | 14 + examples/TemplateFiles.cs | 38 - examples/TemplateFiles.java | 34 - examples/TemplateFiles.js | 21 - examples/TemplateFiles.php | 25 - examples/TemplateFiles.py | 21 - examples/TemplateFiles.rb | 20 - examples/TemplateFiles.ts | 21 - examples/TemplateFilesAsDataUri.cs | 34 - examples/TemplateFilesAsDataUri.java | 33 - examples/TemplateFilesAsDataUri.js | 19 - examples/TemplateFilesAsDataUri.php | 24 - examples/TemplateFilesAsDataUri.py | 21 - examples/TemplateFilesAsDataUri.rb | 20 - examples/TemplateFilesAsDataUri.ts | 19 - examples/TemplateFilesAsDataUriExample.cs | 35 + examples/TemplateFilesAsDataUriExample.java | 40 + examples/TemplateFilesAsDataUriExample.php | 22 + examples/TemplateFilesAsDataUriExample.py | 20 + examples/TemplateFilesAsDataUriExample.rb | 17 + ...ri.sh => TemplateFilesAsDataUriExample.sh} | 0 examples/TemplateFilesAsDataUriExample.ts | 16 + examples/TemplateFilesAsFileUrl.cs | 34 - examples/TemplateFilesAsFileUrl.java | 33 - examples/TemplateFilesAsFileUrl.js | 19 - examples/TemplateFilesAsFileUrl.php | 24 - examples/TemplateFilesAsFileUrl.py | 21 - examples/TemplateFilesAsFileUrl.rb | 20 - examples/TemplateFilesAsFileUrl.ts | 19 - examples/TemplateFilesAsFileUrlExample.cs | 36 + examples/TemplateFilesAsFileUrlExample.java | 41 + examples/TemplateFilesAsFileUrlExample.php | 23 + examples/TemplateFilesAsFileUrlExample.py | 21 + examples/TemplateFilesAsFileUrlExample.rb | 20 + ...rl.sh => TemplateFilesAsFileUrlExample.sh} | 0 examples/TemplateFilesAsFileUrlExample.ts | 17 + examples/TemplateFilesExample.cs | 38 + examples/TemplateFilesExample.java | 40 + examples/TemplateFilesExample.php | 23 + examples/TemplateFilesExample.py | 21 + examples/TemplateFilesExample.rb | 17 + ...mplateFiles.sh => TemplateFilesExample.sh} | 0 examples/TemplateFilesExample.ts | 17 + examples/TemplateGet.cs | 34 - examples/TemplateGet.java | 33 - examples/TemplateGet.js | 19 - examples/TemplateGet.php | 24 - examples/TemplateGet.py | 21 - examples/TemplateGet.rb | 20 - examples/TemplateGet.ts | 19 - examples/TemplateGetExample.cs | 35 + examples/TemplateGetExample.java | 40 + examples/TemplateGetExample.php | 22 + examples/TemplateGetExample.py | 20 + examples/TemplateGetExample.rb | 17 + .../{TemplateGet.sh => TemplateGetExample.sh} | 0 examples/TemplateGetExample.ts | 16 + examples/TemplateList.cs | 34 - examples/TemplateList.java | 36 - examples/TemplateList.js | 19 - examples/TemplateList.php | 24 - examples/TemplateList.py | 23 - examples/TemplateList.rb | 20 - examples/TemplateList.ts | 19 - examples/TemplateListExample.cs | 38 + examples/TemplateListExample.java | 43 + examples/TemplateListExample.php | 25 + examples/TemplateListExample.py | 23 + examples/TemplateListExample.rb | 22 + ...TemplateList.sh => TemplateListExample.sh} | 0 examples/TemplateListExample.ts | 19 + examples/TemplateRemoveUser.cs | 38 - examples/TemplateRemoveUser.java | 36 - examples/TemplateRemoveUser.js | 23 - examples/TemplateRemoveUser.php | 27 - examples/TemplateRemoveUser.py | 25 - examples/TemplateRemoveUser.rb | 23 - examples/TemplateRemoveUser.ts | 23 - examples/TemplateRemoveUserExample.cs | 40 + examples/TemplateRemoveUserExample.java | 44 + examples/TemplateRemoveUserExample.php | 26 + examples/TemplateRemoveUserExample.py | 25 + examples/TemplateRemoveUserExample.rb | 21 + ...veUser.sh => TemplateRemoveUserExample.sh} | 0 examples/TemplateRemoveUserExample.ts | 20 + examples/TemplateUpdateFiles.cs | 48 - examples/TemplateUpdateFiles.java | 38 - examples/TemplateUpdateFiles.js | 24 - examples/TemplateUpdateFiles.php | 27 - examples/TemplateUpdateFiles.py | 25 - examples/TemplateUpdateFiles.rb | 23 - examples/TemplateUpdateFiles.ts | 24 - examples/TemplateUpdateFilesExample.cs | 46 + examples/TemplateUpdateFilesExample.java | 46 + examples/TemplateUpdateFilesExample.php | 27 + examples/TemplateUpdateFilesExample.py | 27 + examples/TemplateUpdateFilesExample.rb | 23 + ...Files.sh => TemplateUpdateFilesExample.sh} | 0 examples/TemplateUpdateFilesExample.ts | 22 + examples/UnclaimedDraftCreate.cs | 85 - examples/UnclaimedDraftCreate.java | 67 - examples/UnclaimedDraftCreate.js | 64 - examples/UnclaimedDraftCreate.php | 60 - examples/UnclaimedDraftCreate.rb | 56 - examples/UnclaimedDraftCreate.ts | 64 - examples/UnclaimedDraftCreateEmbedded.cs | 49 - examples/UnclaimedDraftCreateEmbedded.java | 39 - examples/UnclaimedDraftCreateEmbedded.js | 25 - examples/UnclaimedDraftCreateEmbedded.php | 28 - examples/UnclaimedDraftCreateEmbedded.py | 26 - examples/UnclaimedDraftCreateEmbedded.rb | 24 - examples/UnclaimedDraftCreateEmbedded.ts | 25 - .../UnclaimedDraftCreateEmbeddedExample.cs | 48 + .../UnclaimedDraftCreateEmbeddedExample.java | 48 + .../UnclaimedDraftCreateEmbeddedExample.php | 29 + .../UnclaimedDraftCreateEmbeddedExample.py | 29 + .../UnclaimedDraftCreateEmbeddedExample.rb | 25 + ...=> UnclaimedDraftCreateEmbeddedExample.sh} | 0 .../UnclaimedDraftCreateEmbeddedExample.ts | 24 + ...aftCreateEmbeddedFormFieldGroupsExample.cs | 95 + ...tCreateEmbeddedFormFieldGroupsExample.java | 94 + ...ftCreateEmbeddedFormFieldGroupsExample.php | 76 + ...aftCreateEmbeddedFormFieldGroupsExample.py | 78 + ...aftCreateEmbeddedFormFieldGroupsExample.rb | 71 + ...aftCreateEmbeddedFormFieldGroupsExample.ts | 70 + ...raftCreateEmbeddedFormFieldRulesExample.cs | 115 + ...ftCreateEmbeddedFormFieldRulesExample.java | 110 + ...aftCreateEmbeddedFormFieldRulesExample.php | 92 + ...raftCreateEmbeddedFormFieldRulesExample.py | 96 + ...raftCreateEmbeddedFormFieldRulesExample.rb | 87 + ...raftCreateEmbeddedFormFieldRulesExample.ts | 86 + ...ateEmbeddedFormFieldsPerDocumentExample.cs | 81 + ...eEmbeddedFormFieldsPerDocumentExample.java | 82 + ...teEmbeddedFormFieldsPerDocumentExample.php | 64 + ...ateEmbeddedFormFieldsPerDocumentExample.py | 65 + ...ateEmbeddedFormFieldsPerDocumentExample.rb | 59 + ...ateEmbeddedFormFieldsPerDocumentExample.ts | 58 + ...nclaimedDraftCreateEmbeddedWithTemplate.cs | 52 - ...laimedDraftCreateEmbeddedWithTemplate.java | 50 - ...nclaimedDraftCreateEmbeddedWithTemplate.js | 37 - ...claimedDraftCreateEmbeddedWithTemplate.php | 39 - ...nclaimedDraftCreateEmbeddedWithTemplate.py | 41 - ...nclaimedDraftCreateEmbeddedWithTemplate.rb | 35 - ...nclaimedDraftCreateEmbeddedWithTemplate.ts | 37 - ...dDraftCreateEmbeddedWithTemplateExample.cs | 67 + ...raftCreateEmbeddedWithTemplateExample.java | 67 + ...DraftCreateEmbeddedWithTemplateExample.php | 49 + ...dDraftCreateEmbeddedWithTemplateExample.py | 50 + ...dDraftCreateEmbeddedWithTemplateExample.rb | 44 + ...DraftCreateEmbeddedWithTemplateExample.sh} | 0 ...dDraftCreateEmbeddedWithTemplateExample.ts | 43 + examples/UnclaimedDraftCreateExample.cs | 59 + examples/UnclaimedDraftCreateExample.java | 57 + examples/UnclaimedDraftCreateExample.php | 38 + examples/UnclaimedDraftCreateExample.py | 39 + examples/UnclaimedDraftCreateExample.rb | 34 + ...eate.sh => UnclaimedDraftCreateExample.sh} | 0 examples/UnclaimedDraftCreateExample.ts | 33 + ...laimedDraftCreateFormFieldGroupsExample.cs | 94 + ...imedDraftCreateFormFieldGroupsExample.java | 93 + ...aimedDraftCreateFormFieldGroupsExample.php | 75 + ...laimedDraftCreateFormFieldGroupsExample.py | 77 + ...laimedDraftCreateFormFieldGroupsExample.rb | 70 + ...laimedDraftCreateFormFieldGroupsExample.ts | 69 + ...claimedDraftCreateFormFieldRulesExample.cs | 114 + ...aimedDraftCreateFormFieldRulesExample.java | 109 + ...laimedDraftCreateFormFieldRulesExample.php | 91 + ...claimedDraftCreateFormFieldRulesExample.py | 95 + ...claimedDraftCreateFormFieldRulesExample.rb | 86 + ...claimedDraftCreateFormFieldRulesExample.ts | 85 + ...DraftCreateFormFieldsPerDocumentExample.cs | 80 + ...aftCreateFormFieldsPerDocumentExample.java | 81 + ...raftCreateFormFieldsPerDocumentExample.php | 63 + ...DraftCreateFormFieldsPerDocumentExample.py | 64 + ...DraftCreateFormFieldsPerDocumentExample.rb | 58 + ...DraftCreateFormFieldsPerDocumentExample.ts | 57 + examples/UnclaimedDraftEditAndResend.cs | 39 - examples/UnclaimedDraftEditAndResend.java | 37 - examples/UnclaimedDraftEditAndResend.js | 24 - examples/UnclaimedDraftEditAndResend.php | 28 - examples/UnclaimedDraftEditAndResend.py | 28 - examples/UnclaimedDraftEditAndResend.rb | 24 - examples/UnclaimedDraftEditAndResend.ts | 24 - .../UnclaimedDraftEditAndResendExample.cs | 41 + .../UnclaimedDraftEditAndResendExample.java | 45 + .../UnclaimedDraftEditAndResendExample.php | 27 + .../UnclaimedDraftEditAndResendExample.py | 26 + .../UnclaimedDraftEditAndResendExample.rb | 22 + ... => UnclaimedDraftEditAndResendExample.sh} | 0 .../UnclaimedDraftEditAndResendExample.ts | 21 + ...e.json => AccountCreateOAuthResponse.json} | 0 ...Example.json => AccountCreateRequest.json} | 0 ...le.json => AccountCreateRequestOAuth.json} | 0 ...xample.json => AccountCreateResponse.json} | 0 ...seExample.json => AccountGetResponse.json} | 0 ...Example.json => AccountUpdateRequest.json} | 0 ...xample.json => AccountUpdateResponse.json} | 0 ...e.json => AccountVerifyFoundResponse.json} | 0 ...son => AccountVerifyNotFoundResponse.json} | 0 ...Example.json => AccountVerifyRequest.json} | 0 ...tExample.json => ApiAppCreateRequest.json} | 1 + ...Example.json => ApiAppCreateResponse.json} | 0 ...nseExample.json => ApiAppGetResponse.json} | 0 ...seExample.json => ApiAppListResponse.json} | 0 examples/json/ApiAppUpdateRequest.json | 19 + .../ApiAppUpdateRequestDefaultExample.json | 8 - ...Example.json => ApiAppUpdateResponse.json} | 0 ...ample.json => BulkSendJobGetResponse.json} | 0 ...mple.json => BulkSendJobListResponse.json} | 0 ...ample.json => EmbeddedEditUrlRequest.json} | 0 ...mple.json => EmbeddedEditUrlResponse.json} | 0 ...mple.json => EmbeddedSignUrlResponse.json} | 0 ...onseExample.json => Error400Response.json} | 0 ...onseExample.json => Error401Response.json} | 0 ...onseExample.json => Error402Response.json} | 0 ...onseExample.json => Error403Response.json} | 0 ...onseExample.json => Error404Response.json} | 0 ...onseExample.json => Error409Response.json} | 0 ...onseExample.json => Error410Response.json} | 0 ...onseExample.json => Error422Response.json} | 0 ...onseExample.json => Error429Response.json} | 0 ...onseExample.json => Error4XXResponse.json} | 0 ...tCallbackAccountSignatureRequestSent.json} | 0 ... EventCallbackAccountTemplateCreated.json} | 0 ... => EventCallbackAppAccountConfirmed.json} | 0 ...EventCallbackAppSignatureRequestSent.json} | 0 ...n => EventCallbackAppTemplateCreated.json} | 0 ...sponseExample.json => FaxGetResponse.json} | 0 ...xample.json => FaxLineAddUserRequest.json} | 0 ...e.json => FaxLineAreaCodeGetResponse.json} | 0 ...Example.json => FaxLineCreateRequest.json} | 0 ...Example.json => FaxLineDeleteRequest.json} | 0 ...eExample.json => FaxLineListResponse.json} | 0 ...ple.json => FaxLineRemoveUserRequest.json} | 0 ...ponseExample.json => FaxLineResponse.json} | 0 ...ponseExample.json => FaxListResponse.json} | 0 ...equestExample.json => FaxSendRequest.json} | 4 +- ...le.json => OAuthTokenGenerateRequest.json} | 0 ...e.json => OAuthTokenGenerateResponse.json} | 0 ...ple.json => OAuthTokenRefreshRequest.json} | 0 ...le.json => OAuthTokenRefreshResponse.json} | 0 ...tExample.json => ReportCreateRequest.json} | 0 ...Example.json => ReportCreateResponse.json} | 0 ...ulkCreateEmbeddedWithTemplateRequest.json} | 0 ...eEmbeddedWithTemplateRequestFormData.json} | 0 ...lkCreateEmbeddedWithTemplateResponse.json} | 0 ...reRequestBulkSendWithTemplateRequest.json} | 0 ...tBulkSendWithTemplateRequestFormData.json} | 0 ...eRequestBulkSendWithTemplateResponse.json} | 0 ...ignatureRequestCreateEmbeddedRequest.json} | 4 +- ...tCreateEmbeddedRequestGroupedSigners.json} | 0 ...gnatureRequestCreateEmbeddedResponse.json} | 0 ...estCreateEmbeddedWithTemplateRequest.json} | 0 ...stCreateEmbeddedWithTemplateResponse.json} | 0 ... SignatureRequestEditEmbeddedRequest.json} | 4 +- ...estEditEmbeddedRequestGroupedSigners.json} | 0 ...SignatureRequestEditEmbeddedResponse.json} | 0 ...questEditEmbeddedWithTemplateRequest.json} | 0 ...uestEditEmbeddedWithTemplateResponse.json} | 0 ....json => SignatureRequestEditRequest.json} | 4 +- ...tureRequestEditRequestGroupedSigners.json} | 0 ...json => SignatureRequestEditResponse.json} | 0 ...natureRequestEditWithTemplateRequest.json} | 0 ...atureRequestEditWithTemplateResponse.json} | 0 ...son => SignatureRequestFilesResponse.json} | 0 ....json => SignatureRequestGetResponse.json} | 0 ...json => SignatureRequestListResponse.json} | 0 ... SignatureRequestReleaseHoldResponse.json} | 0 ...son => SignatureRequestRemindRequest.json} | 0 ...on => SignatureRequestRemindResponse.json} | 0 ....json => SignatureRequestSendRequest.json} | 4 +- ...tureRequestSendRequestGroupedSigners.json} | 0 ...json => SignatureRequestSendResponse.json} | 0 ...natureRequestSendWithTemplateRequest.json} | 0 ...atureRequestSendWithTemplateResponse.json} | 0 ...son => SignatureRequestUpdateRequest.json} | 0 ...on => SignatureRequestUpdateResponse.json} | 0 ...Example.json => TeamAddMemberRequest.json} | 0 ...son => TeamAddMemberRequestAccountId.json} | 0 ...xample.json => TeamAddMemberResponse.json} | 0 ...ultExample.json => TeamCreateRequest.json} | 0 ...seExample.json => TeamCreateResponse.json} | 0 ...ple.json => TeamDoesNotExistResponse.json} | 0 ...eExample.json => TeamGetInfoResponse.json} | 0 ...ponseExample.json => TeamGetResponse.json} | 0 ...mple.json => TeamGetRootInfoResponse.json} | 0 ...eExample.json => TeamInvitesResponse.json} | 0 ...eExample.json => TeamMembersResponse.json} | 0 ...mple.json => TeamRemoveMemberRequest.json} | 0 ... => TeamRemoveMemberRequestAccountId.json} | 0 ...ple.json => TeamRemoveMemberResponse.json} | 0 ...Example.json => TeamSubTeamsResponse.json} | 0 ...ultExample.json => TeamUpdateRequest.json} | 0 ...seExample.json => TeamUpdateResponse.json} | 0 ...ample.json => TemplateAddUserRequest.json} | 0 ...mple.json => TemplateAddUserResponse.json} | 0 ...> TemplateCreateEmbeddedDraftRequest.json} | 4 +- ...eEmbeddedDraftRequestFormFieldGroups.json} | 0 ...teEmbeddedDraftRequestFormFieldRules.json} | 0 ...dedDraftRequestFormFieldsPerDocument.json} | 0 ... TemplateCreateEmbeddedDraftResponse.json} | 0 ...xample.json => TemplateCreateRequest.json} | 4 +- ...TemplateCreateRequestFormFieldGroups.json} | 0 ... TemplateCreateRequestFormFieldRules.json} | 0 ...teCreateRequestFormFieldsPerDocument.json} | 0 ...ample.json => TemplateCreateResponse.json} | 0 ...xample.json => TemplateFilesResponse.json} | 0 ...eExample.json => TemplateGetResponse.json} | 0 ...Example.json => TemplateListResponse.json} | 0 ...le.json => TemplateRemoveUserRequest.json} | 0 ...e.json => TemplateRemoveUserResponse.json} | 0 examples/json/TemplateUpdateFilesRequest.json | 5 + ...plateUpdateFilesRequestDefaultExample.json | 5 - ....json => TemplateUpdateFilesResponse.json} | 0 ... UnclaimedDraftCreateEmbeddedRequest.json} | 4 +- ...CreateEmbeddedRequestFormFieldGroups.json} | 0 ...tCreateEmbeddedRequestFormFieldRules.json} | 0 ...EmbeddedRequestFormFieldsPerDocument.json} | 0 ...UnclaimedDraftCreateEmbeddedResponse.json} | 0 ...aftCreateEmbeddedWithTemplateRequest.json} | 0 ...ftCreateEmbeddedWithTemplateResponse.json} | 0 ....json => UnclaimedDraftCreateRequest.json} | 4 +- ...medDraftCreateRequestFormFieldGroups.json} | 0 ...imedDraftCreateRequestFormFieldRules.json} | 0 ...ftCreateRequestFormFieldsPerDocument.json} | 0 ...json => UnclaimedDraftCreateResponse.json} | 0 ....json => UnclaimedDraftEditAndResend.json} | 0 ...> UnclaimedDraftEditAndResendRequest.json} | 0 generate-sdks | 13 +- openapi-raw.yaml | 3408 ++++++++--------- openapi-sdk.yaml | 3408 ++++++++--------- openapi.yaml | 3232 +++++++--------- sandbox/.gitignore | 46 +- sandbox/dotnet/Dropbox.SignSandbox.sln | 21 + .../.config.dist.json | 6 - .../src/Dropbox.SignSandbox.Test/.gitignore | 1 - .../Dropbox.SignSandbox.Test.csproj | 24 - .../SignatureRequestTests.cs | 168 - .../AccountCreateExample.cs | 39 + .../AccountCreateOauthExample.cs | 41 + .../Dropbox.SignSandbox/AccountGetExample.cs | 33 + .../AccountUpdateExample.cs | 40 + .../AccountVerifyExample.cs | 39 + .../ApiAppCreateExample.cs | 61 + .../ApiAppDeleteExample.cs | 33 + .../Dropbox.SignSandbox/ApiAppGetExample.cs | 35 + .../Dropbox.SignSandbox/ApiAppListExample.cs | 36 + .../ApiAppUpdateExample.cs | 63 + .../BulkSendJobGetExample.cs | 37 + .../BulkSendJobListExample.cs | 36 + .../Dropbox.SignSandbox.csproj | 7 +- .../EmbeddedEditUrlExample.cs | 45 + .../EmbeddedSignUrlExample.cs | 35 + .../dotnet/src/Dropbox.SignSandbox/Entry.cs | 8 + .../EventCallbackExample.cs | 44 + .../Dropbox.SignSandbox/FaxDeleteExample.cs | 17 +- .../Dropbox.SignSandbox/FaxFilesExample.cs | 36 + .../src/Dropbox.SignSandbox/FaxGetExample.cs | 34 + .../FaxLineAddUserExample.cs | 21 +- .../FaxLineAreaCodeGetExample.cs | 37 + .../FaxLineCreateExample.cs | 39 + .../FaxLineDeleteExample.cs | 36 + .../Dropbox.SignSandbox/FaxLineGetExample.cs | 34 + .../Dropbox.SignSandbox/FaxLineListExample.cs | 37 + .../FaxLineRemoveUserExample.cs | 39 + .../src/Dropbox.SignSandbox/FaxListExample.cs | 35 + .../src/Dropbox.SignSandbox/FaxSendExample.cs | 51 + .../OauthTokenGenerateExample.cs | 41 + .../OauthTokenRefreshExample.cs | 38 + .../dotnet/src/Dropbox.SignSandbox/Program.cs | 39 - .../ReportCreateExample.cs | 43 + ...stBulkCreateEmbeddedWithTemplateExample.cs | 116 + ...atureRequestBulkSendWithTemplateExample.cs | 116 + .../SignatureRequestCancelExample.cs | 33 + .../SignatureRequestCreateEmbeddedExample.cs | 82 + ...uestCreateEmbeddedGroupedSignersExample.cs | 110 + ...equestCreateEmbeddedWithTemplateExample.cs | 66 + .../SignatureRequestEditEmbeddedExample.cs | 83 + ...equestEditEmbeddedGroupedSignersExample.cs | 111 + ...eRequestEditEmbeddedWithTemplateExample.cs | 67 + .../SignatureRequestEditExample.cs | 93 + ...gnatureRequestEditGroupedSignersExample.cs | 121 + ...SignatureRequestEditWithTemplateExample.cs | 90 + .../SignatureRequestFilesAsDataUriExample.cs | 35 + .../SignatureRequestFilesAsFileUrlExample.cs | 36 + .../SignatureRequestFilesExample.cs | 38 + .../SignatureRequestGetExample.cs | 35 + .../SignatureRequestListExample.cs | 38 + .../SignatureRequestReleaseHoldExample.cs | 35 + .../SignatureRequestRemindExample.cs | 40 + .../SignatureRequestRemoveExample.cs | 32 + .../SignatureRequestSendExample.cs | 92 + ...gnatureRequestSendGroupedSignersExample.cs | 120 + ...SignatureRequestSendWithTemplateExample.cs | 89 + .../SignatureRequestUpdateExample.cs | 41 + .../TeamAddMemberAccountIdExample.cs | 40 + .../TeamAddMemberExample.cs | 40 + .../Dropbox.SignSandbox/TeamCreateExample.cs | 39 + .../Dropbox.SignSandbox/TeamDeleteExample.cs | 16 +- .../src/Dropbox.SignSandbox/TeamGetExample.cs | 33 + .../Dropbox.SignSandbox/TeamInfoExample.cs | 35 + .../Dropbox.SignSandbox/TeamInvitesExample.cs | 33 + .../Dropbox.SignSandbox/TeamMembersExample.cs | 37 + .../TeamRemoveMemberAccountIdExample.cs | 39 + .../TeamRemoveMemberExample.cs | 40 + .../TeamSubTeamsExample.cs | 37 + .../Dropbox.SignSandbox/TeamUpdateExample.cs | 39 + .../TemplateAddUserExample.cs | 40 + .../TemplateCreateEmbeddedDraftExample.cs | 92 + ...eateEmbeddedDraftFormFieldGroupsExample.cs | 139 + ...reateEmbeddedDraftFormFieldRulesExample.cs | 159 + ...beddedDraftFormFieldsPerDocumentExample.cs | 125 + .../TemplateCreateExample.cs | 129 + .../TemplateCreateFormFieldGroupsExample.cs | 139 + .../TemplateCreateFormFieldRulesExample.cs | 159 + ...plateCreateFormFieldsPerDocumentExample.cs | 125 + .../TemplateDeleteExample.cs | 33 + .../TemplateFilesAsDataUriExample.cs | 35 + .../TemplateFilesAsFileUrlExample.cs | 36 + .../TemplateFilesExample.cs | 38 + .../Dropbox.SignSandbox/TemplateGetExample.cs | 35 + .../TemplateListExample.cs | 38 + .../TemplateRemoveUserExample.cs | 40 + .../TemplateUpdateFilesExample.cs | 46 + .../UnclaimedDraftCreateEmbeddedExample.cs | 48 + ...aftCreateEmbeddedFormFieldGroupsExample.cs | 95 + ...raftCreateEmbeddedFormFieldRulesExample.cs | 115 + ...ateEmbeddedFormFieldsPerDocumentExample.cs | 81 + ...dDraftCreateEmbeddedWithTemplateExample.cs | 67 + .../UnclaimedDraftCreateExample.cs | 59 + ...laimedDraftCreateFormFieldGroupsExample.cs | 94 + ...claimedDraftCreateFormFieldRulesExample.cs | 114 + ...DraftCreateFormFieldsPerDocumentExample.cs | 80 + .../UnclaimedDraftEditAndResendExample.cs | 41 + ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/dotnet/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sandbox/java-v1/pom.xml | 39 - .../java/com/dropbox/sign_sandbox/Main.java | 37 - .../dropbox/sign_sandbox/.config.dist.json | 6 - .../test/com/dropbox/sign_sandbox/.gitignore | 1 - .../sign_sandbox/SignatureRequestTest.java | 148 - ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/java-v1/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sandbox/java-v2/pom.xml | 33 - .../java/com/dropbox/sign_sandbox/Main.java | 37 - .../dropbox/sign_sandbox/.config.dist.json | 6 - .../test/com/dropbox/sign_sandbox/.gitignore | 1 - .../sign_sandbox/SignatureRequestTest.java | 148 - ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/java-v2/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sandbox/java/.gitignore | 7 + sandbox/java/DropboxSignSandbox.iml | 7 + sandbox/java/build.gradle | 109 + .../sign_sandbox/AccountCreateExample.java | 43 + .../AccountCreateOauthExample.java | 45 + .../sign_sandbox/AccountGetExample.java | 38 + .../sign_sandbox/AccountUpdateExample.java | 44 + .../sign_sandbox/AccountVerifyExample.java | 43 + .../sign_sandbox/ApiAppCreateExample.java | 60 + .../sign_sandbox/ApiAppDeleteExample.java | 38 + .../sign_sandbox/ApiAppGetExample.java | 40 + .../sign_sandbox/ApiAppListExample.java | 41 + .../sign_sandbox/ApiAppUpdateExample.java | 62 + .../sign_sandbox/BulkSendJobGetExample.java | 42 + .../sign_sandbox/BulkSendJobListExample.java | 41 + .../sign_sandbox/EmbeddedEditUrlExample.java | 49 + .../sign_sandbox/EmbeddedSignUrlExample.java | 40 + .../sign_sandbox/EventCallbackExample.java | 39 + .../sign_sandbox/FaxDeleteExample.java | 37 + .../dropbox/sign_sandbox/FaxFilesExample.java | 38 + .../dropbox/sign_sandbox/FaxGetExample.java | 39 + .../sign_sandbox/FaxLineAddUserExample.java | 43 + .../FaxLineAreaCodeGetExample.java | 42 + .../sign_sandbox/FaxLineCreateExample.java | 43 + .../sign_sandbox/FaxLineDeleteExample.java | 40 + .../sign_sandbox/FaxLineGetExample.java | 39 + .../sign_sandbox/FaxLineListExample.java | 42 + .../FaxLineRemoveUserExample.java | 43 + .../dropbox/sign_sandbox/FaxListExample.java | 40 + .../dropbox/sign_sandbox/FaxSendExample.java | 51 + .../java/com/dropbox/sign_sandbox/Main.java | 6 + .../OauthTokenGenerateExample.java | 45 + .../OauthTokenRefreshExample.java | 42 + .../sign_sandbox/ReportCreateExample.java | 47 + ...BulkCreateEmbeddedWithTemplateExample.java | 107 + ...ureRequestBulkSendWithTemplateExample.java | 107 + .../SignatureRequestCancelExample.java | 38 + ...SignatureRequestCreateEmbeddedExample.java | 78 + ...stCreateEmbeddedGroupedSignersExample.java | 104 + ...uestCreateEmbeddedWithTemplateExample.java | 67 + .../SignatureRequestEditEmbeddedExample.java | 79 + ...uestEditEmbeddedGroupedSignersExample.java | 105 + ...equestEditEmbeddedWithTemplateExample.java | 68 + .../SignatureRequestEditExample.java | 88 + ...atureRequestEditGroupedSignersExample.java | 114 + ...gnatureRequestEditWithTemplateExample.java | 87 + ...SignatureRequestFilesAsDataUriExample.java | 40 + ...SignatureRequestFilesAsFileUrlExample.java | 41 + .../SignatureRequestFilesExample.java | 40 + .../SignatureRequestGetExample.java | 40 + .../SignatureRequestListExample.java | 43 + .../SignatureRequestReleaseHoldExample.java | 40 + .../SignatureRequestRemindExample.java | 44 + .../SignatureRequestRemoveExample.java | 37 + .../SignatureRequestSendExample.java | 87 + ...atureRequestSendGroupedSignersExample.java | 113 + ...gnatureRequestSendWithTemplateExample.java | 86 + .../SignatureRequestUpdateExample.java | 45 + .../TeamAddMemberAccountIdExample.java | 44 + .../sign_sandbox/TeamAddMemberExample.java | 44 + .../sign_sandbox/TeamCreateExample.java | 43 + .../sign_sandbox/TeamDeleteExample.java | 36 + .../dropbox/sign_sandbox/TeamGetExample.java | 38 + .../dropbox/sign_sandbox/TeamInfoExample.java | 40 + .../sign_sandbox/TeamInvitesExample.java | 38 + .../sign_sandbox/TeamMembersExample.java | 42 + .../TeamRemoveMemberAccountIdExample.java | 43 + .../sign_sandbox/TeamRemoveMemberExample.java | 44 + .../sign_sandbox/TeamSubTeamsExample.java | 42 + .../sign_sandbox/TeamUpdateExample.java | 43 + .../sign_sandbox/TemplateAddUserExample.java | 44 + .../TemplateCreateEmbeddedDraftExample.java | 85 + ...teEmbeddedDraftFormFieldGroupsExample.java | 131 + ...ateEmbeddedDraftFormFieldRulesExample.java | 147 + ...ddedDraftFormFieldsPerDocumentExample.java | 119 + .../sign_sandbox/TemplateCreateExample.java | 119 + .../TemplateCreateFormFieldGroupsExample.java | 131 + .../TemplateCreateFormFieldRulesExample.java | 147 + ...ateCreateFormFieldsPerDocumentExample.java | 119 + .../sign_sandbox/TemplateDeleteExample.java | 38 + .../TemplateFilesAsDataUriExample.java | 40 + .../TemplateFilesAsFileUrlExample.java | 41 + .../sign_sandbox/TemplateFilesExample.java | 40 + .../sign_sandbox/TemplateGetExample.java | 40 + .../sign_sandbox/TemplateListExample.java | 43 + .../TemplateRemoveUserExample.java | 44 + .../TemplateUpdateFilesExample.java | 46 + .../UnclaimedDraftCreateEmbeddedExample.java | 48 + ...tCreateEmbeddedFormFieldGroupsExample.java | 94 + ...ftCreateEmbeddedFormFieldRulesExample.java | 110 + ...eEmbeddedFormFieldsPerDocumentExample.java | 82 + ...raftCreateEmbeddedWithTemplateExample.java | 67 + .../UnclaimedDraftCreateExample.java | 57 + ...imedDraftCreateFormFieldGroupsExample.java | 93 + ...aimedDraftCreateFormFieldRulesExample.java | 109 + ...aftCreateFormFieldsPerDocumentExample.java | 81 + .../UnclaimedDraftEditAndResendExample.java | 45 + sandbox/node/.gitignore | 32 + sandbox/node/Example.ts | 21 - sandbox/node/package.json | 12 +- sandbox/node/src/AccountCreateExample.ts | 19 + sandbox/node/src/AccountCreateOauthExample.ts | 21 + sandbox/node/src/AccountGetExample.ts | 14 + sandbox/node/src/AccountUpdateExample.ts | 20 + sandbox/node/src/AccountVerifyExample.ts | 19 + sandbox/node/src/ApiAppCreateExample.ts | 36 + sandbox/node/src/ApiAppDeleteExample.ts | 14 + sandbox/node/src/ApiAppGetExample.ts | 16 + sandbox/node/src/ApiAppListExample.ts | 17 + sandbox/node/src/ApiAppUpdateExample.ts | 38 + sandbox/node/src/BulkSendJobGetExample.ts | 18 + sandbox/node/src/BulkSendJobListExample.ts | 17 + sandbox/node/src/EmbeddedEditUrlExample.ts | 26 + sandbox/node/src/EmbeddedSignUrlExample.ts | 16 + .../node/src/EventCallbackExample.ts | 0 sandbox/node/src/FaxDeleteExample.ts | 13 + sandbox/node/src/FaxFilesExample.ts | 15 + sandbox/node/src/FaxGetExample.ts | 15 + sandbox/node/src/FaxLineAddUserExample.ts | 19 + sandbox/node/src/FaxLineAreaCodeGetExample.ts | 18 + sandbox/node/src/FaxLineCreateExample.ts | 19 + sandbox/node/src/FaxLineDeleteExample.ts | 16 + sandbox/node/src/FaxLineGetExample.ts | 15 + sandbox/node/src/FaxLineListExample.ts | 18 + sandbox/node/src/FaxLineRemoveUserExample.ts | 19 + sandbox/node/src/FaxListExample.ts | 16 + sandbox/node/src/FaxSendExample.ts | 27 + sandbox/node/src/OauthTokenGenerateExample.ts | 21 + sandbox/node/src/OauthTokenRefreshExample.ts | 18 + sandbox/node/src/ReportCreateExample.ts | 23 + ...stBulkCreateEmbeddedWithTemplateExample.ts | 83 + ...atureRequestBulkSendWithTemplateExample.ts | 83 + .../node/src/SignatureRequestCancelExample.ts | 14 + .../SignatureRequestCreateEmbeddedExample.ts | 54 + ...uestCreateEmbeddedGroupedSignersExample.ts | 80 + ...equestCreateEmbeddedWithTemplateExample.ts | 43 + .../SignatureRequestEditEmbeddedExample.ts | 55 + ...equestEditEmbeddedGroupedSignersExample.ts | 81 + ...eRequestEditEmbeddedWithTemplateExample.ts | 44 + .../node/src/SignatureRequestEditExample.ts | 62 + ...gnatureRequestEditGroupedSignersExample.ts | 88 + ...SignatureRequestEditWithTemplateExample.ts | 63 + .../SignatureRequestFilesAsDataUriExample.ts | 16 + .../SignatureRequestFilesAsFileUrlExample.ts | 17 + .../node/src/SignatureRequestFilesExample.ts | 17 + .../node/src/SignatureRequestGetExample.ts | 16 + .../node/src/SignatureRequestListExample.ts | 19 + .../src/SignatureRequestReleaseHoldExample.ts | 16 + .../node/src/SignatureRequestRemindExample.ts | 20 + .../node/src/SignatureRequestRemoveExample.ts | 13 + .../node/src/SignatureRequestSendExample.ts | 61 + ...gnatureRequestSendGroupedSignersExample.ts | 87 + ...SignatureRequestSendWithTemplateExample.ts | 62 + .../node/src/SignatureRequestUpdateExample.ts | 21 + .../node/src/TeamAddMemberAccountIdExample.ts | 20 + sandbox/node/src/TeamAddMemberExample.ts | 20 + sandbox/node/src/TeamCreateExample.ts | 19 + sandbox/node/src/TeamDeleteExample.ts | 12 + sandbox/node/src/TeamGetExample.ts | 14 + sandbox/node/src/TeamInfoExample.ts | 16 + sandbox/node/src/TeamInvitesExample.ts | 14 + sandbox/node/src/TeamMembersExample.ts | 18 + .../src/TeamRemoveMemberAccountIdExample.ts | 19 + sandbox/node/src/TeamRemoveMemberExample.ts | 20 + sandbox/node/src/TeamSubTeamsExample.ts | 18 + sandbox/node/src/TeamUpdateExample.ts | 19 + sandbox/node/src/TemplateAddUserExample.ts | 20 + .../src/TemplateCreateEmbeddedDraftExample.ts | 61 + ...eateEmbeddedDraftFormFieldGroupsExample.ts | 107 + ...reateEmbeddedDraftFormFieldRulesExample.ts | 123 + ...beddedDraftFormFieldsPerDocumentExample.ts | 95 + sandbox/node/src/TemplateCreateExample.ts | 95 + .../TemplateCreateFormFieldGroupsExample.ts | 107 + .../TemplateCreateFormFieldRulesExample.ts | 123 + ...plateCreateFormFieldsPerDocumentExample.ts | 95 + sandbox/node/src/TemplateDeleteExample.ts | 14 + .../node/src/TemplateFilesAsDataUriExample.ts | 16 + .../node/src/TemplateFilesAsFileUrlExample.ts | 17 + sandbox/node/src/TemplateFilesExample.ts | 17 + sandbox/node/src/TemplateGetExample.ts | 16 + sandbox/node/src/TemplateListExample.ts | 19 + sandbox/node/src/TemplateRemoveUserExample.ts | 20 + .../node/src/TemplateUpdateFilesExample.ts | 22 + .../UnclaimedDraftCreateEmbeddedExample.ts | 24 + ...aftCreateEmbeddedFormFieldGroupsExample.ts | 70 + ...raftCreateEmbeddedFormFieldRulesExample.ts | 86 + ...ateEmbeddedFormFieldsPerDocumentExample.ts | 58 + ...dDraftCreateEmbeddedWithTemplateExample.ts | 43 + .../node/src/UnclaimedDraftCreateExample.ts | 33 + ...laimedDraftCreateFormFieldGroupsExample.ts | 69 + ...claimedDraftCreateFormFieldRulesExample.ts | 85 + ...DraftCreateFormFieldsPerDocumentExample.ts | 57 + .../src/UnclaimedDraftEditAndResendExample.ts | 21 + ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/node/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sandbox/node/tests/.config.dist.json | 6 - sandbox/node/tests/.gitignore | 1 - sandbox/node/tests/signatureRequest.test.ts | 140 - sandbox/node/tsconfig.json | 32 + sandbox/php/.gitignore | 2 + sandbox/php/Example.php | 25 - sandbox/php/composer.json | 2 +- sandbox/php/src/AccountCreateExample.php | 25 + sandbox/php/src/AccountCreateOauthExample.php | 27 + sandbox/php/src/AccountGetExample.php | 20 + sandbox/php/src/AccountUpdateExample.php | 26 + sandbox/php/src/AccountVerifyExample.php | 25 + sandbox/php/src/ApiAppCreateExample.php | 42 + sandbox/php/src/ApiAppDeleteExample.php | 20 + sandbox/php/src/ApiAppGetExample.php | 22 + sandbox/php/src/ApiAppListExample.php | 23 + sandbox/php/src/ApiAppUpdateExample.php | 44 + sandbox/php/src/BulkSendJobGetExample.php | 24 + sandbox/php/src/BulkSendJobListExample.php | 23 + sandbox/php/src/EmbeddedEditUrlExample.php | 32 + sandbox/php/src/EmbeddedSignUrlExample.php | 22 + sandbox/php/src/EventCallbackExample.php | 35 + sandbox/php/src/FaxDeleteExample.php | 19 + sandbox/php/src/FaxFilesExample.php | 21 + sandbox/php/src/FaxGetExample.php | 21 + sandbox/php/src/FaxLineAddUserExample.php | 25 + sandbox/php/src/FaxLineAreaCodeGetExample.php | 24 + sandbox/php/src/FaxLineCreateExample.php | 25 + sandbox/php/src/FaxLineDeleteExample.php | 22 + sandbox/php/src/FaxLineGetExample.php | 21 + sandbox/php/src/FaxLineListExample.php | 24 + sandbox/php/src/FaxLineRemoveUserExample.php | 25 + sandbox/php/src/FaxListExample.php | 22 + sandbox/php/src/FaxSendExample.php | 32 + sandbox/php/src/OauthTokenGenerateExample.php | 27 + sandbox/php/src/OauthTokenRefreshExample.php | 24 + sandbox/php/src/ReportCreateExample.php | 29 + ...tBulkCreateEmbeddedWithTemplateExample.php | 89 + ...tureRequestBulkSendWithTemplateExample.php | 89 + .../php/src/SignatureRequestCancelExample.php | 20 + .../SignatureRequestCreateEmbeddedExample.php | 59 + ...estCreateEmbeddedGroupedSignersExample.php | 86 + ...questCreateEmbeddedWithTemplateExample.php | 49 + .../SignatureRequestEditEmbeddedExample.php | 60 + ...questEditEmbeddedGroupedSignersExample.php | 87 + ...RequestEditEmbeddedWithTemplateExample.php | 50 + .../php/src/SignatureRequestEditExample.php | 69 + ...natureRequestEditGroupedSignersExample.php | 96 + ...ignatureRequestEditWithTemplateExample.php | 69 + .../SignatureRequestFilesAsDataUriExample.php | 22 + .../SignatureRequestFilesAsFileUrlExample.php | 23 + .../php/src/SignatureRequestFilesExample.php | 23 + .../php/src/SignatureRequestGetExample.php | 22 + .../php/src/SignatureRequestListExample.php | 25 + .../SignatureRequestReleaseHoldExample.php | 22 + .../php/src/SignatureRequestRemindExample.php | 26 + .../php/src/SignatureRequestRemoveExample.php | 19 + .../php/src/SignatureRequestSendExample.php | 68 + ...natureRequestSendGroupedSignersExample.php | 95 + ...ignatureRequestSendWithTemplateExample.php | 68 + .../php/src/SignatureRequestUpdateExample.php | 27 + .../php/src/TeamAddMemberAccountIdExample.php | 26 + sandbox/php/src/TeamAddMemberExample.php | 26 + sandbox/php/src/TeamCreateExample.php | 25 + sandbox/php/src/TeamDeleteExample.php | 18 + sandbox/php/src/TeamGetExample.php | 20 + sandbox/php/src/TeamInfoExample.php | 22 + sandbox/php/src/TeamInvitesExample.php | 20 + sandbox/php/src/TeamMembersExample.php | 24 + .../src/TeamRemoveMemberAccountIdExample.php | 25 + sandbox/php/src/TeamRemoveMemberExample.php | 26 + sandbox/php/src/TeamSubTeamsExample.php | 24 + sandbox/php/src/TeamUpdateExample.php | 25 + sandbox/php/src/TemplateAddUserExample.php | 26 + .../TemplateCreateEmbeddedDraftExample.php | 66 + ...ateEmbeddedDraftFormFieldGroupsExample.php | 113 + ...eateEmbeddedDraftFormFieldRulesExample.php | 129 + ...eddedDraftFormFieldsPerDocumentExample.php | 101 + sandbox/php/src/TemplateCreateExample.php | 100 + .../TemplateCreateFormFieldGroupsExample.php | 113 + .../TemplateCreateFormFieldRulesExample.php | 129 + ...lateCreateFormFieldsPerDocumentExample.php | 101 + sandbox/php/src/TemplateDeleteExample.php | 20 + .../php/src/TemplateFilesAsDataUriExample.php | 22 + .../php/src/TemplateFilesAsFileUrlExample.php | 23 + sandbox/php/src/TemplateFilesExample.php | 23 + sandbox/php/src/TemplateGetExample.php | 22 + sandbox/php/src/TemplateListExample.php | 25 + sandbox/php/src/TemplateRemoveUserExample.php | 26 + .../php/src/TemplateUpdateFilesExample.php | 27 + .../UnclaimedDraftCreateEmbeddedExample.php | 29 + ...ftCreateEmbeddedFormFieldGroupsExample.php | 76 + ...aftCreateEmbeddedFormFieldRulesExample.php | 92 + ...teEmbeddedFormFieldsPerDocumentExample.php | 64 + ...DraftCreateEmbeddedWithTemplateExample.php | 49 + .../php/src/UnclaimedDraftCreateExample.php | 38 + ...aimedDraftCreateFormFieldGroupsExample.php | 75 + ...laimedDraftCreateFormFieldRulesExample.php | 91 + ...raftCreateFormFieldsPerDocumentExample.php | 63 + .../UnclaimedDraftEditAndResendExample.php | 27 + sandbox/php/test/.config.dist.json | 6 - sandbox/php/test/.gitignore | 1 - sandbox/php/test/SignatureRequestTest.php | 151 - ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/php/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sandbox/python/.gitignore | 2 + sandbox/python/Example.py | 25 - sandbox/python/src/AccountCreateExample.py | 24 + .../python/src/AccountCreateOauthExample.py | 26 + sandbox/python/src/AccountGetExample.py | 18 + sandbox/python/src/AccountUpdateExample.py | 25 + sandbox/python/src/AccountVerifyExample.py | 24 + sandbox/python/src/ApiAppCreateExample.py | 43 + sandbox/python/src/ApiAppDeleteExample.py | 18 + sandbox/python/src/ApiAppGetExample.py | 20 + sandbox/python/src/ApiAppListExample.py | 21 + sandbox/python/src/ApiAppUpdateExample.py | 45 + sandbox/python/src/BulkSendJobGetExample.py | 22 + sandbox/python/src/BulkSendJobListExample.py | 21 + sandbox/python/src/EmbeddedEditUrlExample.py | 31 + sandbox/python/src/EmbeddedSignUrlExample.py | 20 + sandbox/python/src/EventCallbackExample.py | 31 + sandbox/python/src/FaxDeleteExample.py | 17 + sandbox/python/src/FaxFilesExample.py | 19 + sandbox/python/src/FaxGetExample.py | 19 + .../python/src/FaxLineAddUserExample.py | 16 +- .../python/src/FaxLineAreaCodeGetExample.py | 22 + sandbox/python/src/FaxLineCreateExample.py | 24 + sandbox/python/src/FaxLineDeleteExample.py | 21 + sandbox/python/src/FaxLineGetExample.py | 19 + sandbox/python/src/FaxLineListExample.py | 22 + .../python/src/FaxLineRemoveUserExample.py | 24 + sandbox/python/src/FaxListExample.py | 20 + sandbox/python/src/FaxSendExample.py | 32 + .../python/src/OauthTokenGenerateExample.py | 26 + .../python/src/OauthTokenRefreshExample.py | 23 + sandbox/python/src/ReportCreateExample.py | 28 + ...stBulkCreateEmbeddedWithTemplateExample.py | 95 + ...atureRequestBulkSendWithTemplateExample.py | 95 + .../src/SignatureRequestCancelExample.py | 18 + .../SignatureRequestCreateEmbeddedExample.py | 62 + ...uestCreateEmbeddedGroupedSignersExample.py | 92 + ...equestCreateEmbeddedWithTemplateExample.py | 50 + .../SignatureRequestEditEmbeddedExample.py | 63 + ...equestEditEmbeddedGroupedSignersExample.py | 93 + ...eRequestEditEmbeddedWithTemplateExample.py | 51 + .../python/src/SignatureRequestEditExample.py | 73 + ...gnatureRequestEditGroupedSignersExample.py | 103 + ...SignatureRequestEditWithTemplateExample.py | 72 + .../SignatureRequestFilesAsDataUriExample.py | 20 + .../SignatureRequestFilesAsFileUrlExample.py | 21 + .../src/SignatureRequestFilesExample.py | 21 + .../python/src/SignatureRequestGetExample.py | 20 + .../python/src/SignatureRequestListExample.py | 23 + .../src/SignatureRequestReleaseHoldExample.py | 20 + .../src/SignatureRequestRemindExample.py | 25 + .../src/SignatureRequestRemoveExample.py | 17 + .../python/src/SignatureRequestSendExample.py | 74 +- ...gnatureRequestSendGroupedSignersExample.py | 102 + ...SignatureRequestSendWithTemplateExample.py | 65 +- .../src/SignatureRequestUpdateExample.py | 26 + .../src/TeamAddMemberAccountIdExample.py | 25 + sandbox/python/src/TeamAddMemberExample.py | 25 + sandbox/python/src/TeamCreateExample.py | 24 + sandbox/python/src/TeamDeleteExample.py | 16 + .../python/src/TeamGetExample.py | 13 +- sandbox/python/src/TeamInfoExample.py | 20 + sandbox/python/src/TeamInvitesExample.py | 18 + sandbox/python/src/TeamMembersExample.py | 22 + .../src/TeamRemoveMemberAccountIdExample.py | 24 + sandbox/python/src/TeamRemoveMemberExample.py | 25 + sandbox/python/src/TeamSubTeamsExample.py | 22 + sandbox/python/src/TeamUpdateExample.py | 24 + sandbox/python/src/TemplateAddUserExample.py | 25 + .../src/TemplateCreateEmbeddedDraftExample.py | 71 + ...eateEmbeddedDraftFormFieldGroupsExample.py | 120 + ...reateEmbeddedDraftFormFieldRulesExample.py | 138 + ...beddedDraftFormFieldsPerDocumentExample.py | 107 + sandbox/python/src/TemplateCreateExample.py | 107 + .../TemplateCreateFormFieldGroupsExample.py | 120 + .../TemplateCreateFormFieldRulesExample.py | 138 + ...plateCreateFormFieldsPerDocumentExample.py | 107 + sandbox/python/src/TemplateDeleteExample.py | 18 + .../src/TemplateFilesAsDataUriExample.py | 20 + .../src/TemplateFilesAsFileUrlExample.py | 21 + sandbox/python/src/TemplateFilesExample.py | 21 + sandbox/python/src/TemplateGetExample.py | 20 + sandbox/python/src/TemplateListExample.py | 23 + .../python/src/TemplateRemoveUserExample.py | 25 + .../python/src/TemplateUpdateFilesExample.py | 27 + .../UnclaimedDraftCreateEmbeddedExample.py | 29 + ...aftCreateEmbeddedFormFieldGroupsExample.py | 78 + ...raftCreateEmbeddedFormFieldRulesExample.py | 96 + ...ateEmbeddedFormFieldsPerDocumentExample.py | 65 + ...dDraftCreateEmbeddedWithTemplateExample.py | 50 + .../python/src/UnclaimedDraftCreateExample.py | 39 + ...laimedDraftCreateFormFieldGroupsExample.py | 77 + ...claimedDraftCreateFormFieldRulesExample.py | 95 + ...DraftCreateFormFieldsPerDocumentExample.py | 64 + .../src/UnclaimedDraftEditAndResendExample.py | 26 + ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/python/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sandbox/python/tests/.config.dist.json | 6 - sandbox/python/tests/.gitignore | 1 - .../python/tests/test_signature_request.py | 124 - sandbox/ruby/.gitignore | 1 + sandbox/ruby/spec/.config.dist.json | 6 - sandbox/ruby/spec/.gitignore | 1 - sandbox/ruby/spec/signature_request_spec.rb | 133 - sandbox/ruby/spec/spec_helper.rb | 111 - sandbox/ruby/src/AccountCreateExample.rb | 20 + sandbox/ruby/src/AccountCreateOauthExample.rb | 22 + sandbox/ruby/src/AccountGetExample.rb | 15 + sandbox/ruby/src/AccountUpdateExample.rb | 21 + sandbox/ruby/src/AccountVerifyExample.rb | 20 + sandbox/ruby/src/ApiAppCreateExample.rb | 37 + sandbox/ruby/src/ApiAppDeleteExample.rb | 15 + sandbox/ruby/src/ApiAppGetExample.rb | 17 + sandbox/ruby/src/ApiAppListExample.rb | 20 + sandbox/ruby/src/ApiAppUpdateExample.rb | 39 + sandbox/ruby/src/BulkSendJobGetExample.rb | 21 + sandbox/ruby/src/BulkSendJobListExample.rb | 20 + sandbox/ruby/src/EmbeddedEditUrlExample.rb | 27 + sandbox/ruby/src/EmbeddedSignUrlExample.rb | 17 + sandbox/ruby/src/EventCallbackExample.rb | 29 + sandbox/ruby/src/FaxDeleteExample.rb | 14 + sandbox/ruby/src/FaxFilesExample.rb | 16 + sandbox/ruby/src/FaxGetExample.rb | 16 + sandbox/ruby/src/FaxLineAddUserExample.rb | 20 + sandbox/ruby/src/FaxLineAreaCodeGetExample.rb | 16 + sandbox/ruby/src/FaxLineCreateExample.rb | 20 + sandbox/ruby/src/FaxLineDeleteExample.rb | 17 + sandbox/ruby/src/FaxLineGetExample.rb | 16 + sandbox/ruby/src/FaxLineListExample.rb | 21 + sandbox/ruby/src/FaxLineRemoveUserExample.rb | 20 + sandbox/ruby/src/FaxListExample.rb | 19 + sandbox/ruby/src/FaxSendExample.rb | 28 + sandbox/ruby/src/OauthTokenGenerateExample.rb | 22 + sandbox/ruby/src/OauthTokenRefreshExample.rb | 19 + sandbox/ruby/src/ReportCreateExample.rb | 24 + ...stBulkCreateEmbeddedWithTemplateExample.rb | 84 + ...atureRequestBulkSendWithTemplateExample.rb | 84 + .../ruby/src/SignatureRequestCancelExample.rb | 15 + .../SignatureRequestCreateEmbeddedExample.rb | 55 + ...uestCreateEmbeddedGroupedSignersExample.rb | 81 + ...equestCreateEmbeddedWithTemplateExample.rb | 44 + .../SignatureRequestEditEmbeddedExample.rb | 56 + ...equestEditEmbeddedGroupedSignersExample.rb | 82 + ...eRequestEditEmbeddedWithTemplateExample.rb | 45 + .../ruby/src/SignatureRequestEditExample.rb | 66 + ...gnatureRequestEditGroupedSignersExample.rb | 92 + ...SignatureRequestEditWithTemplateExample.rb | 64 + .../SignatureRequestFilesAsDataUriExample.rb | 17 + .../SignatureRequestFilesAsFileUrlExample.rb | 20 + .../ruby/src/SignatureRequestFilesExample.rb | 20 + .../ruby/src/SignatureRequestGetExample.rb | 17 + .../ruby/src/SignatureRequestListExample.rb | 22 + .../src/SignatureRequestReleaseHoldExample.rb | 17 + .../ruby/src/SignatureRequestRemindExample.rb | 21 + .../ruby/src/SignatureRequestRemoveExample.rb | 14 + .../ruby/src/SignatureRequestSendExample.rb | 65 + ...gnatureRequestSendGroupedSignersExample.rb | 91 + ...SignatureRequestSendWithTemplateExample.rb | 63 + .../ruby/src/SignatureRequestUpdateExample.rb | 22 + .../ruby/src/TeamAddMemberAccountIdExample.rb | 23 + sandbox/ruby/src/TeamAddMemberExample.rb | 23 + sandbox/ruby/src/TeamCreateExample.rb | 20 + sandbox/ruby/src/TeamDeleteExample.rb | 13 + sandbox/ruby/src/TeamGetExample.rb | 15 + sandbox/ruby/src/TeamInfoExample.rb | 19 + sandbox/ruby/src/TeamInvitesExample.rb | 15 + sandbox/ruby/src/TeamMembersExample.rb | 21 + .../src/TeamRemoveMemberAccountIdExample.rb | 20 + sandbox/ruby/src/TeamRemoveMemberExample.rb | 21 + sandbox/ruby/src/TeamSubTeamsExample.rb | 21 + sandbox/ruby/src/TeamUpdateExample.rb | 20 + sandbox/ruby/src/TemplateAddUserExample.rb | 21 + .../src/TemplateCreateEmbeddedDraftExample.rb | 62 + ...eateEmbeddedDraftFormFieldGroupsExample.rb | 108 + ...reateEmbeddedDraftFormFieldRulesExample.rb | 124 + ...beddedDraftFormFieldsPerDocumentExample.rb | 96 + sandbox/ruby/src/TemplateCreateExample.rb | 96 + .../TemplateCreateFormFieldGroupsExample.rb | 108 + .../TemplateCreateFormFieldRulesExample.rb | 124 + ...plateCreateFormFieldsPerDocumentExample.rb | 96 + sandbox/ruby/src/TemplateDeleteExample.rb | 15 + .../ruby/src/TemplateFilesAsDataUriExample.rb | 17 + .../ruby/src/TemplateFilesAsFileUrlExample.rb | 20 + sandbox/ruby/src/TemplateFilesExample.rb | 17 + sandbox/ruby/src/TemplateGetExample.rb | 17 + sandbox/ruby/src/TemplateListExample.rb | 22 + sandbox/ruby/src/TemplateRemoveUserExample.rb | 21 + .../ruby/src/TemplateUpdateFilesExample.rb | 23 + .../UnclaimedDraftCreateEmbeddedExample.rb | 25 + ...aftCreateEmbeddedFormFieldGroupsExample.rb | 71 + ...raftCreateEmbeddedFormFieldRulesExample.rb | 87 + ...ateEmbeddedFormFieldsPerDocumentExample.rb | 59 + ...dDraftCreateEmbeddedWithTemplateExample.rb | 44 + .../ruby/src/UnclaimedDraftCreateExample.rb | 34 + ...laimedDraftCreateFormFieldGroupsExample.rb | 70 + ...claimedDraftCreateFormFieldRulesExample.rb | 86 + ...DraftCreateFormFieldsPerDocumentExample.rb | 58 + .../src/UnclaimedDraftEditAndResendExample.rb | 22 + ...SignatureRequestCreateEmbeddedRequest.json | 163 - .../SignatureRequestSendRequest.json | 163 - sandbox/ruby/test_fixtures/pdf-sample.pdf | Bin 7945 -> 0 bytes sdks/dotnet/README.md | 27 +- sdks/dotnet/docs/AccountApi.md | 107 +- sdks/dotnet/docs/ApiAppApi.md | 181 +- sdks/dotnet/docs/BulkSendJobApi.md | 56 +- sdks/dotnet/docs/EmbeddedApi.md | 61 +- sdks/dotnet/docs/FaxApi.md | 130 +- sdks/dotnet/docs/FaxLineApi.md | 146 +- sdks/dotnet/docs/OAuthApi.md | 50 +- sdks/dotnet/docs/ReportApi.md | 29 +- sdks/dotnet/docs/SignatureRequestApi.md | 1160 +++--- sdks/dotnet/docs/TeamApi.md | 257 +- sdks/dotnet/docs/TemplateApi.md | 485 ++- sdks/dotnet/docs/UnclaimedDraftApi.md | 216 +- sdks/dotnet/openapi-config.yaml | 4 + sdks/dotnet/templates/Entry.cs | 8 + sdks/java-v1/README.md | 47 +- sdks/java-v1/docs/AccountApi.md | 187 +- sdks/java-v1/docs/ApiAppApi.md | 297 +- sdks/java-v1/docs/BulkSendJobApi.md | 94 +- sdks/java-v1/docs/EmbeddedApi.md | 103 +- sdks/java-v1/docs/FaxApi.md | 204 +- sdks/java-v1/docs/FaxLineApi.md | 278 +- sdks/java-v1/docs/OAuthApi.md | 88 +- sdks/java-v1/docs/ReportApi.md | 58 +- sdks/java-v1/docs/SignatureRequestApi.md | 1613 ++++---- sdks/java-v1/docs/TeamApi.md | 459 ++- sdks/java-v1/docs/TemplateApi.md | 704 ++-- sdks/java-v1/docs/UnclaimedDraftApi.md | 280 +- sdks/java-v2/README.md | 47 +- sdks/java-v2/docs/AccountApi.md | 187 +- sdks/java-v2/docs/ApiAppApi.md | 297 +- sdks/java-v2/docs/BulkSendJobApi.md | 94 +- sdks/java-v2/docs/EmbeddedApi.md | 103 +- sdks/java-v2/docs/FaxApi.md | 204 +- sdks/java-v2/docs/FaxLineApi.md | 278 +- sdks/java-v2/docs/OAuthApi.md | 88 +- sdks/java-v2/docs/ReportApi.md | 58 +- sdks/java-v2/docs/SignatureRequestApi.md | 1613 ++++---- sdks/java-v2/docs/TeamApi.md | 459 ++- sdks/java-v2/docs/TemplateApi.md | 704 ++-- sdks/java-v2/docs/UnclaimedDraftApi.md | 280 +- sdks/java-v2/openapi-config.yaml | 4 + sdks/java-v2/templates/Main.java | 6 + sdks/node/README.md | 53 +- sdks/node/bin/generate-examples.php | 2 +- sdks/node/docs/api/AccountApi.md | 202 +- sdks/node/docs/api/ApiAppApi.md | 357 +- sdks/node/docs/api/BulkSendJobApi.md | 109 +- sdks/node/docs/api/EmbeddedApi.md | 120 +- sdks/node/docs/api/FaxApi.md | 282 +- sdks/node/docs/api/FaxLineApi.md | 318 +- sdks/node/docs/api/OAuthApi.md | 91 +- sdks/node/docs/api/ReportApi.md | 67 +- sdks/node/docs/api/SignatureRequestApi.md | 2331 ++++------- sdks/node/docs/api/TeamApi.md | 500 +-- sdks/node/docs/api/TemplateApi.md | 881 ++--- sdks/node/docs/api/UnclaimedDraftApi.md | 403 +- sdks/node/openapi-config.yaml | 4 + sdks/node/templates/dropbox-README.mustache | 6 - sdks/node/templates/dropbox-api-doc.mustache | 6 - sdks/php/README.md | 28 +- sdks/php/docs/Api/AccountApi.md | 107 +- sdks/php/docs/Api/ApiAppApi.md | 173 +- sdks/php/docs/Api/BulkSendJobApi.md | 56 +- sdks/php/docs/Api/EmbeddedApi.md | 62 +- sdks/php/docs/Api/FaxApi.md | 126 +- sdks/php/docs/Api/FaxLineApi.md | 175 +- sdks/php/docs/Api/OAuthApi.md | 58 +- sdks/php/docs/Api/ReportApi.md | 26 +- sdks/php/docs/Api/SignatureRequestApi.md | 1071 +++--- sdks/php/docs/Api/TeamApi.md | 258 +- sdks/php/docs/Api/TemplateApi.md | 449 ++- sdks/php/docs/Api/UnclaimedDraftApi.md | 184 +- sdks/php/openapi-config.yaml | 6 + sdks/python/README.md | 17 +- sdks/python/bin/generate-examples.php | 1 - sdks/python/docs/AccountApi.md | 65 +- sdks/python/docs/ApiAppApi.md | 121 +- sdks/python/docs/BulkSendJobApi.md | 39 +- sdks/python/docs/EmbeddedApi.md | 43 +- sdks/python/docs/FaxApi.md | 90 +- sdks/python/docs/FaxLineApi.md | 111 +- sdks/python/docs/OAuthApi.md | 36 +- sdks/python/docs/ReportApi.md | 23 +- sdks/python/docs/SignatureRequestApi.md | 1000 +++-- sdks/python/docs/TeamApi.md | 164 +- sdks/python/docs/TemplateApi.md | 339 +- sdks/python/docs/UnclaimedDraftApi.md | 176 +- sdks/python/openapi-config.yaml | 3 + sdks/ruby/README.md | 19 +- sdks/ruby/docs/AccountApi.md | 71 +- sdks/ruby/docs/ApiAppApi.md | 128 +- sdks/ruby/docs/BulkSendJobApi.md | 42 +- sdks/ruby/docs/EmbeddedApi.md | 44 +- sdks/ruby/docs/FaxApi.md | 92 +- sdks/ruby/docs/FaxLineApi.md | 115 +- sdks/ruby/docs/OAuthApi.md | 42 +- sdks/ruby/docs/ReportApi.md | 27 +- sdks/ruby/docs/SignatureRequestApi.md | 974 ++--- sdks/ruby/docs/TeamApi.md | 179 +- sdks/ruby/docs/TemplateApi.md | 376 +- sdks/ruby/docs/UnclaimedDraftApi.md | 168 +- sdks/ruby/openapi-config.yaml | 3 + 1985 files changed, 68716 insertions(+), 37475 deletions(-) rename bin/{sandbox-java-v2 => sandbox-java} (64%) delete mode 100755 bin/sandbox-java-v1 create mode 100755 bin/sandbox-ruby delete mode 100644 examples/AccountCreate.cs delete mode 100644 examples/AccountCreate.java delete mode 100644 examples/AccountCreate.js delete mode 100644 examples/AccountCreate.php delete mode 100644 examples/AccountCreate.rb delete mode 100644 examples/AccountCreate.ts create mode 100644 examples/AccountCreateExample.cs create mode 100644 examples/AccountCreateExample.java create mode 100644 examples/AccountCreateExample.php rename examples/{AccountCreate.py => AccountCreateExample.py} (52%) create mode 100644 examples/AccountCreateExample.rb rename examples/{AccountCreate.sh => AccountCreateExample.sh} (100%) create mode 100644 examples/AccountCreateExample.ts create mode 100644 examples/AccountCreateOauthExample.cs create mode 100644 examples/AccountCreateOauthExample.java create mode 100644 examples/AccountCreateOauthExample.php create mode 100644 examples/AccountCreateOauthExample.py create mode 100644 examples/AccountCreateOauthExample.rb create mode 100644 examples/AccountCreateOauthExample.ts delete mode 100644 examples/AccountGet.cs delete mode 100644 examples/AccountGet.java delete mode 100644 examples/AccountGet.js delete mode 100644 examples/AccountGet.php delete mode 100644 examples/AccountGet.rb delete mode 100644 examples/AccountGet.ts create mode 100644 examples/AccountGetExample.cs create mode 100644 examples/AccountGetExample.java create mode 100644 examples/AccountGetExample.php rename examples/{FaxLineAreaCodeGet.py => AccountGetExample.py} (52%) create mode 100644 examples/AccountGetExample.rb rename examples/{AccountGet.sh => AccountGetExample.sh} (100%) create mode 100644 examples/AccountGetExample.ts delete mode 100644 examples/AccountUpdate.cs delete mode 100644 examples/AccountUpdate.java delete mode 100644 examples/AccountUpdate.js delete mode 100644 examples/AccountUpdate.php delete mode 100644 examples/AccountUpdate.rb delete mode 100644 examples/AccountUpdate.ts create mode 100644 examples/AccountUpdateExample.cs create mode 100644 examples/AccountUpdateExample.java create mode 100644 examples/AccountUpdateExample.php rename examples/{AccountUpdate.py => AccountUpdateExample.py} (51%) create mode 100644 examples/AccountUpdateExample.rb rename examples/{AccountUpdate.sh => AccountUpdateExample.sh} (100%) create mode 100644 examples/AccountUpdateExample.ts delete mode 100644 examples/AccountVerify.cs delete mode 100644 examples/AccountVerify.java delete mode 100644 examples/AccountVerify.js delete mode 100644 examples/AccountVerify.php delete mode 100644 examples/AccountVerify.rb delete mode 100644 examples/AccountVerify.ts create mode 100644 examples/AccountVerifyExample.cs create mode 100644 examples/AccountVerifyExample.java create mode 100644 examples/AccountVerifyExample.php rename examples/{AccountVerify.py => AccountVerifyExample.py} (52%) create mode 100644 examples/AccountVerifyExample.rb rename examples/{AccountVerify.sh => AccountVerifyExample.sh} (100%) create mode 100644 examples/AccountVerifyExample.ts delete mode 100644 examples/ApiAppCreate.cs delete mode 100644 examples/ApiAppCreate.java delete mode 100644 examples/ApiAppCreate.js delete mode 100644 examples/ApiAppCreate.php delete mode 100644 examples/ApiAppCreate.rb delete mode 100644 examples/ApiAppCreate.ts create mode 100644 examples/ApiAppCreateExample.cs create mode 100644 examples/ApiAppCreateExample.java create mode 100644 examples/ApiAppCreateExample.php rename examples/{ApiAppCreate.py => ApiAppCreateExample.py} (55%) create mode 100644 examples/ApiAppCreateExample.rb rename examples/{ApiAppCreate.sh => ApiAppCreateExample.sh} (100%) create mode 100644 examples/ApiAppCreateExample.ts delete mode 100644 examples/ApiAppDelete.cs delete mode 100644 examples/ApiAppDelete.java delete mode 100644 examples/ApiAppDelete.js delete mode 100644 examples/ApiAppDelete.php delete mode 100644 examples/ApiAppDelete.py delete mode 100644 examples/ApiAppDelete.rb delete mode 100644 examples/ApiAppDelete.ts create mode 100644 examples/ApiAppDeleteExample.cs create mode 100644 examples/ApiAppDeleteExample.java create mode 100644 examples/ApiAppDeleteExample.php create mode 100644 examples/ApiAppDeleteExample.py create mode 100644 examples/ApiAppDeleteExample.rb rename examples/{ApiAppDelete.sh => ApiAppDeleteExample.sh} (100%) create mode 100644 examples/ApiAppDeleteExample.ts delete mode 100644 examples/ApiAppGet.cs delete mode 100644 examples/ApiAppGet.java delete mode 100644 examples/ApiAppGet.js delete mode 100644 examples/ApiAppGet.php delete mode 100644 examples/ApiAppGet.py delete mode 100644 examples/ApiAppGet.rb delete mode 100644 examples/ApiAppGet.ts create mode 100644 examples/ApiAppGetExample.cs create mode 100644 examples/ApiAppGetExample.java create mode 100644 examples/ApiAppGetExample.php rename examples/{AccountGet.py => ApiAppGetExample.py} (50%) create mode 100644 examples/ApiAppGetExample.rb rename examples/{ApiAppGet.sh => ApiAppGetExample.sh} (100%) create mode 100644 examples/ApiAppGetExample.ts delete mode 100644 examples/ApiAppList.cs delete mode 100644 examples/ApiAppList.java delete mode 100644 examples/ApiAppList.js delete mode 100644 examples/ApiAppList.php delete mode 100644 examples/ApiAppList.py delete mode 100644 examples/ApiAppList.rb delete mode 100644 examples/ApiAppList.ts create mode 100644 examples/ApiAppListExample.cs create mode 100644 examples/ApiAppListExample.java create mode 100644 examples/ApiAppListExample.php create mode 100644 examples/ApiAppListExample.py create mode 100644 examples/ApiAppListExample.rb rename examples/{ApiAppList.sh => ApiAppListExample.sh} (100%) create mode 100644 examples/ApiAppListExample.ts delete mode 100644 examples/ApiAppUpdate.cs delete mode 100644 examples/ApiAppUpdate.java delete mode 100644 examples/ApiAppUpdate.js delete mode 100644 examples/ApiAppUpdate.php delete mode 100644 examples/ApiAppUpdate.py delete mode 100644 examples/ApiAppUpdate.rb delete mode 100644 examples/ApiAppUpdate.ts create mode 100644 examples/ApiAppUpdateExample.cs create mode 100644 examples/ApiAppUpdateExample.java create mode 100644 examples/ApiAppUpdateExample.php create mode 100644 examples/ApiAppUpdateExample.py create mode 100644 examples/ApiAppUpdateExample.rb rename examples/{ApiAppUpdate.sh => ApiAppUpdateExample.sh} (100%) create mode 100644 examples/ApiAppUpdateExample.ts delete mode 100644 examples/BulkSendJobGet.cs delete mode 100644 examples/BulkSendJobGet.java delete mode 100644 examples/BulkSendJobGet.js delete mode 100644 examples/BulkSendJobGet.php delete mode 100644 examples/BulkSendJobGet.py delete mode 100644 examples/BulkSendJobGet.rb delete mode 100644 examples/BulkSendJobGet.ts create mode 100644 examples/BulkSendJobGetExample.cs create mode 100644 examples/BulkSendJobGetExample.java create mode 100644 examples/BulkSendJobGetExample.php create mode 100644 examples/BulkSendJobGetExample.py create mode 100644 examples/BulkSendJobGetExample.rb rename examples/{BulkSendJobGet.sh => BulkSendJobGetExample.sh} (100%) create mode 100644 examples/BulkSendJobGetExample.ts delete mode 100644 examples/BulkSendJobList.cs delete mode 100644 examples/BulkSendJobList.java delete mode 100644 examples/BulkSendJobList.js delete mode 100644 examples/BulkSendJobList.php delete mode 100644 examples/BulkSendJobList.py delete mode 100644 examples/BulkSendJobList.rb delete mode 100644 examples/BulkSendJobList.ts create mode 100644 examples/BulkSendJobListExample.cs create mode 100644 examples/BulkSendJobListExample.java create mode 100644 examples/BulkSendJobListExample.php create mode 100644 examples/BulkSendJobListExample.py create mode 100644 examples/BulkSendJobListExample.rb rename examples/{BulkSendJobList.sh => BulkSendJobListExample.sh} (100%) create mode 100644 examples/BulkSendJobListExample.ts delete mode 100644 examples/EmbeddedEditUrl.cs delete mode 100644 examples/EmbeddedEditUrl.java delete mode 100644 examples/EmbeddedEditUrl.js delete mode 100644 examples/EmbeddedEditUrl.php delete mode 100644 examples/EmbeddedEditUrl.py delete mode 100644 examples/EmbeddedEditUrl.rb delete mode 100644 examples/EmbeddedEditUrl.ts create mode 100644 examples/EmbeddedEditUrlExample.cs create mode 100644 examples/EmbeddedEditUrlExample.java create mode 100644 examples/EmbeddedEditUrlExample.php create mode 100644 examples/EmbeddedEditUrlExample.py create mode 100644 examples/EmbeddedEditUrlExample.rb rename examples/{EmbeddedEditUrl.sh => EmbeddedEditUrlExample.sh} (100%) create mode 100644 examples/EmbeddedEditUrlExample.ts delete mode 100644 examples/EmbeddedSignUrl.cs delete mode 100644 examples/EmbeddedSignUrl.java delete mode 100644 examples/EmbeddedSignUrl.js delete mode 100644 examples/EmbeddedSignUrl.php delete mode 100644 examples/EmbeddedSignUrl.py delete mode 100644 examples/EmbeddedSignUrl.rb delete mode 100644 examples/EmbeddedSignUrl.ts create mode 100644 examples/EmbeddedSignUrlExample.cs create mode 100644 examples/EmbeddedSignUrlExample.java create mode 100644 examples/EmbeddedSignUrlExample.php create mode 100644 examples/EmbeddedSignUrlExample.py create mode 100644 examples/EmbeddedSignUrlExample.rb rename examples/{EmbeddedSignUrl.sh => EmbeddedSignUrlExample.sh} (100%) create mode 100644 examples/EmbeddedSignUrlExample.ts rename examples/{EventCallback.cs => EventCallbackExample.cs} (91%) rename examples/{EventCallback.java => EventCallbackExample.java} (97%) rename examples/{EventCallback.php => EventCallbackExample.php} (91%) rename examples/{EventCallback.py => EventCallbackExample.py} (100%) rename examples/{EventCallback.rb => EventCallbackExample.rb} (100%) rename examples/{EventCallback.js => EventCallbackExample.ts} (100%) delete mode 100644 examples/FaxDelete.java delete mode 100644 examples/FaxDelete.js delete mode 100644 examples/FaxDelete.php delete mode 100644 examples/FaxDelete.py delete mode 100644 examples/FaxDelete.rb delete mode 100644 examples/FaxDelete.ts rename examples/{FaxLineDelete.cs => FaxDeleteExample.cs} (57%) create mode 100644 examples/FaxDeleteExample.java create mode 100644 examples/FaxDeleteExample.php create mode 100644 examples/FaxDeleteExample.py create mode 100644 examples/FaxDeleteExample.rb rename examples/{FaxDelete.sh => FaxDeleteExample.sh} (100%) create mode 100644 examples/FaxDeleteExample.ts delete mode 100644 examples/FaxFiles.cs delete mode 100644 examples/FaxFiles.java delete mode 100644 examples/FaxFiles.js delete mode 100644 examples/FaxFiles.php delete mode 100644 examples/FaxFiles.py delete mode 100644 examples/FaxFiles.rb delete mode 100644 examples/FaxFiles.ts create mode 100644 examples/FaxFilesExample.cs create mode 100644 examples/FaxFilesExample.java create mode 100644 examples/FaxFilesExample.php create mode 100644 examples/FaxFilesExample.py create mode 100644 examples/FaxFilesExample.rb rename examples/{FaxFiles.sh => FaxFilesExample.sh} (100%) create mode 100644 examples/FaxFilesExample.ts delete mode 100644 examples/FaxGet.cs delete mode 100644 examples/FaxGet.java delete mode 100644 examples/FaxGet.js delete mode 100644 examples/FaxGet.php delete mode 100644 examples/FaxGet.rb delete mode 100644 examples/FaxGet.ts create mode 100644 examples/FaxGetExample.cs create mode 100644 examples/FaxGetExample.java create mode 100644 examples/FaxGetExample.php rename examples/{FaxGet.py => FaxGetExample.py} (50%) create mode 100644 examples/FaxGetExample.rb rename examples/{FaxGet.sh => FaxGetExample.sh} (100%) create mode 100644 examples/FaxGetExample.ts delete mode 100644 examples/FaxLineAddUser.java delete mode 100644 examples/FaxLineAddUser.js delete mode 100644 examples/FaxLineAddUser.php delete mode 100644 examples/FaxLineAddUser.rb delete mode 100644 examples/FaxLineAddUser.ts rename examples/{FaxLineAddUser.cs => FaxLineAddUserExample.cs} (53%) create mode 100644 examples/FaxLineAddUserExample.java create mode 100644 examples/FaxLineAddUserExample.php rename examples/{FaxLineRemoveUser.py => FaxLineAddUserExample.py} (50%) create mode 100644 examples/FaxLineAddUserExample.rb rename examples/{FaxLineAddUser.sh => FaxLineAddUserExample.sh} (100%) create mode 100644 examples/FaxLineAddUserExample.ts delete mode 100644 examples/FaxLineAreaCodeGet.java delete mode 100644 examples/FaxLineAreaCodeGet.js delete mode 100644 examples/FaxLineAreaCodeGet.php delete mode 100644 examples/FaxLineAreaCodeGet.rb delete mode 100644 examples/FaxLineAreaCodeGet.ts create mode 100644 examples/FaxLineAreaCodeGetExample.cs create mode 100644 examples/FaxLineAreaCodeGetExample.java create mode 100644 examples/FaxLineAreaCodeGetExample.php create mode 100644 examples/FaxLineAreaCodeGetExample.py create mode 100644 examples/FaxLineAreaCodeGetExample.rb rename examples/{FaxLineAreaCodeGet.sh => FaxLineAreaCodeGetExample.sh} (100%) create mode 100644 examples/FaxLineAreaCodeGetExample.ts delete mode 100644 examples/FaxLineCreate.java delete mode 100644 examples/FaxLineCreate.js delete mode 100644 examples/FaxLineCreate.php delete mode 100644 examples/FaxLineCreate.py delete mode 100644 examples/FaxLineCreate.rb delete mode 100644 examples/FaxLineCreate.ts create mode 100644 examples/FaxLineCreateExample.cs create mode 100644 examples/FaxLineCreateExample.java create mode 100644 examples/FaxLineCreateExample.php create mode 100644 examples/FaxLineCreateExample.py create mode 100644 examples/FaxLineCreateExample.rb rename examples/{FaxLineCreate.sh => FaxLineCreateExample.sh} (100%) create mode 100644 examples/FaxLineCreateExample.ts delete mode 100644 examples/FaxLineDelete.java delete mode 100644 examples/FaxLineDelete.js delete mode 100644 examples/FaxLineDelete.php delete mode 100644 examples/FaxLineDelete.py delete mode 100644 examples/FaxLineDelete.rb delete mode 100644 examples/FaxLineDelete.ts create mode 100644 examples/FaxLineDeleteExample.cs create mode 100644 examples/FaxLineDeleteExample.java create mode 100644 examples/FaxLineDeleteExample.php create mode 100644 examples/FaxLineDeleteExample.py create mode 100644 examples/FaxLineDeleteExample.rb rename examples/{FaxLineDelete.sh => FaxLineDeleteExample.sh} (100%) create mode 100644 examples/FaxLineDeleteExample.ts delete mode 100644 examples/FaxLineGet.java delete mode 100644 examples/FaxLineGet.js delete mode 100644 examples/FaxLineGet.php delete mode 100644 examples/FaxLineGet.rb delete mode 100644 examples/FaxLineGet.ts create mode 100644 examples/FaxLineGetExample.cs create mode 100644 examples/FaxLineGetExample.java create mode 100644 examples/FaxLineGetExample.php create mode 100644 examples/FaxLineGetExample.py create mode 100644 examples/FaxLineGetExample.rb rename examples/{FaxLineGet.sh => FaxLineGetExample.sh} (100%) create mode 100644 examples/FaxLineGetExample.ts delete mode 100644 examples/FaxLineList.java delete mode 100644 examples/FaxLineList.js delete mode 100644 examples/FaxLineList.php delete mode 100644 examples/FaxLineList.rb delete mode 100644 examples/FaxLineList.ts create mode 100644 examples/FaxLineListExample.cs create mode 100644 examples/FaxLineListExample.java create mode 100644 examples/FaxLineListExample.php create mode 100644 examples/FaxLineListExample.py create mode 100644 examples/FaxLineListExample.rb rename examples/{FaxLineList.sh => FaxLineListExample.sh} (100%) create mode 100644 examples/FaxLineListExample.ts delete mode 100644 examples/FaxLineRemoveUser.java delete mode 100644 examples/FaxLineRemoveUser.js delete mode 100644 examples/FaxLineRemoveUser.php delete mode 100644 examples/FaxLineRemoveUser.rb delete mode 100644 examples/FaxLineRemoveUser.ts create mode 100644 examples/FaxLineRemoveUserExample.cs create mode 100644 examples/FaxLineRemoveUserExample.java create mode 100644 examples/FaxLineRemoveUserExample.php create mode 100644 examples/FaxLineRemoveUserExample.py create mode 100644 examples/FaxLineRemoveUserExample.rb rename examples/{FaxLineRemoveUser.sh => FaxLineRemoveUserExample.sh} (100%) create mode 100644 examples/FaxLineRemoveUserExample.ts delete mode 100644 examples/FaxList.cs delete mode 100644 examples/FaxList.java delete mode 100644 examples/FaxList.js delete mode 100644 examples/FaxList.php delete mode 100644 examples/FaxList.py delete mode 100644 examples/FaxList.rb delete mode 100644 examples/FaxList.ts create mode 100644 examples/FaxListExample.cs create mode 100644 examples/FaxListExample.java create mode 100644 examples/FaxListExample.php rename examples/{FaxLineGet.py => FaxListExample.py} (52%) create mode 100644 examples/FaxListExample.rb rename examples/{FaxList.sh => FaxListExample.sh} (100%) create mode 100644 examples/FaxListExample.ts delete mode 100644 examples/FaxSend.java delete mode 100644 examples/FaxSend.js delete mode 100644 examples/FaxSend.php delete mode 100644 examples/FaxSend.rb delete mode 100644 examples/FaxSend.ts rename examples/{FaxSend.cs => FaxSendExample.cs} (54%) create mode 100644 examples/FaxSendExample.java create mode 100644 examples/FaxSendExample.php rename examples/{FaxSend.py => FaxSendExample.py} (59%) create mode 100644 examples/FaxSendExample.rb rename examples/{FaxSend.sh => FaxSendExample.sh} (100%) create mode 100644 examples/FaxSendExample.ts delete mode 100644 examples/OauthTokenGenerate.cs delete mode 100644 examples/OauthTokenGenerate.java delete mode 100644 examples/OauthTokenGenerate.js delete mode 100644 examples/OauthTokenGenerate.php delete mode 100644 examples/OauthTokenGenerate.py delete mode 100644 examples/OauthTokenGenerate.rb delete mode 100644 examples/OauthTokenGenerate.ts create mode 100644 examples/OauthTokenGenerateExample.cs create mode 100644 examples/OauthTokenGenerateExample.java create mode 100644 examples/OauthTokenGenerateExample.php create mode 100644 examples/OauthTokenGenerateExample.py create mode 100644 examples/OauthTokenGenerateExample.rb rename examples/{OauthTokenGenerate.sh => OauthTokenGenerateExample.sh} (100%) create mode 100644 examples/OauthTokenGenerateExample.ts delete mode 100644 examples/OauthTokenRefresh.cs delete mode 100644 examples/OauthTokenRefresh.java delete mode 100644 examples/OauthTokenRefresh.js delete mode 100644 examples/OauthTokenRefresh.php delete mode 100644 examples/OauthTokenRefresh.py delete mode 100644 examples/OauthTokenRefresh.rb delete mode 100644 examples/OauthTokenRefresh.ts create mode 100644 examples/OauthTokenRefreshExample.cs create mode 100644 examples/OauthTokenRefreshExample.java create mode 100644 examples/OauthTokenRefreshExample.php create mode 100644 examples/OauthTokenRefreshExample.py create mode 100644 examples/OauthTokenRefreshExample.rb rename examples/{OauthTokenRefresh.sh => OauthTokenRefreshExample.sh} (100%) create mode 100644 examples/OauthTokenRefreshExample.ts delete mode 100644 examples/ReportCreate.java delete mode 100644 examples/ReportCreate.js delete mode 100644 examples/ReportCreate.php delete mode 100644 examples/ReportCreate.py delete mode 100644 examples/ReportCreate.rb delete mode 100644 examples/ReportCreate.ts rename examples/{ReportCreate.cs => ReportCreateExample.cs} (53%) create mode 100644 examples/ReportCreateExample.java create mode 100644 examples/ReportCreateExample.php create mode 100644 examples/ReportCreateExample.py create mode 100644 examples/ReportCreateExample.rb rename examples/{ReportCreate.sh => ReportCreateExample.sh} (100%) create mode 100644 examples/ReportCreateExample.ts delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb delete mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts create mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs create mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java create mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php create mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py create mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb rename examples/{SignatureRequestBulkCreateEmbeddedWithTemplate.sh => SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh} (100%) create mode 100644 examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.cs delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.java delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.js delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.php delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.py delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.rb delete mode 100644 examples/SignatureRequestBulkSendWithTemplate.ts create mode 100644 examples/SignatureRequestBulkSendWithTemplateExample.cs create mode 100644 examples/SignatureRequestBulkSendWithTemplateExample.java create mode 100644 examples/SignatureRequestBulkSendWithTemplateExample.php create mode 100644 examples/SignatureRequestBulkSendWithTemplateExample.py create mode 100644 examples/SignatureRequestBulkSendWithTemplateExample.rb rename examples/{SignatureRequestBulkSendWithTemplate.sh => SignatureRequestBulkSendWithTemplateExample.sh} (100%) create mode 100644 examples/SignatureRequestBulkSendWithTemplateExample.ts delete mode 100644 examples/SignatureRequestCancel.cs delete mode 100644 examples/SignatureRequestCancel.java delete mode 100644 examples/SignatureRequestCancel.js delete mode 100644 examples/SignatureRequestCancel.php delete mode 100644 examples/SignatureRequestCancel.py delete mode 100644 examples/SignatureRequestCancel.rb delete mode 100644 examples/SignatureRequestCancel.ts create mode 100644 examples/SignatureRequestCancelExample.cs create mode 100644 examples/SignatureRequestCancelExample.java create mode 100644 examples/SignatureRequestCancelExample.php create mode 100644 examples/SignatureRequestCancelExample.py create mode 100644 examples/SignatureRequestCancelExample.rb rename examples/{SignatureRequestCancel.sh => SignatureRequestCancelExample.sh} (100%) create mode 100644 examples/SignatureRequestCancelExample.ts delete mode 100644 examples/SignatureRequestCreateEmbedded.cs delete mode 100644 examples/SignatureRequestCreateEmbedded.java delete mode 100644 examples/SignatureRequestCreateEmbedded.js delete mode 100644 examples/SignatureRequestCreateEmbedded.php delete mode 100644 examples/SignatureRequestCreateEmbedded.py delete mode 100644 examples/SignatureRequestCreateEmbedded.rb delete mode 100644 examples/SignatureRequestCreateEmbedded.ts create mode 100644 examples/SignatureRequestCreateEmbeddedExample.cs create mode 100644 examples/SignatureRequestCreateEmbeddedExample.java create mode 100644 examples/SignatureRequestCreateEmbeddedExample.php create mode 100644 examples/SignatureRequestCreateEmbeddedExample.py create mode 100644 examples/SignatureRequestCreateEmbeddedExample.rb rename examples/{SignatureRequestCreateEmbedded.sh => SignatureRequestCreateEmbeddedExample.sh} (100%) create mode 100644 examples/SignatureRequestCreateEmbeddedExample.ts create mode 100644 examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs create mode 100644 examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java create mode 100644 examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php create mode 100644 examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py create mode 100644 examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb create mode 100644 examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.cs delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.java delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.js delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.php delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.py delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.rb delete mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplate.ts create mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs create mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplateExample.java create mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplateExample.php create mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplateExample.py create mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb rename examples/{SignatureRequestCreateEmbeddedWithTemplate.sh => SignatureRequestCreateEmbeddedWithTemplateExample.sh} (100%) create mode 100644 examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts delete mode 100644 examples/SignatureRequestEdit.cs delete mode 100644 examples/SignatureRequestEdit.java delete mode 100644 examples/SignatureRequestEdit.js delete mode 100644 examples/SignatureRequestEdit.php delete mode 100644 examples/SignatureRequestEdit.rb delete mode 100644 examples/SignatureRequestEdit.ts delete mode 100644 examples/SignatureRequestEditEmbedded.cs delete mode 100644 examples/SignatureRequestEditEmbedded.java delete mode 100644 examples/SignatureRequestEditEmbedded.js delete mode 100644 examples/SignatureRequestEditEmbedded.php delete mode 100644 examples/SignatureRequestEditEmbedded.py delete mode 100644 examples/SignatureRequestEditEmbedded.rb delete mode 100644 examples/SignatureRequestEditEmbedded.ts create mode 100644 examples/SignatureRequestEditEmbeddedExample.cs create mode 100644 examples/SignatureRequestEditEmbeddedExample.java create mode 100644 examples/SignatureRequestEditEmbeddedExample.php create mode 100644 examples/SignatureRequestEditEmbeddedExample.py create mode 100644 examples/SignatureRequestEditEmbeddedExample.rb rename examples/{SignatureRequestEditEmbedded.sh => SignatureRequestEditEmbeddedExample.sh} (100%) create mode 100644 examples/SignatureRequestEditEmbeddedExample.ts create mode 100644 examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs create mode 100644 examples/SignatureRequestEditEmbeddedGroupedSignersExample.java create mode 100644 examples/SignatureRequestEditEmbeddedGroupedSignersExample.php create mode 100644 examples/SignatureRequestEditEmbeddedGroupedSignersExample.py create mode 100644 examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb create mode 100644 examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.cs delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.java delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.js delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.php delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.py delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.rb delete mode 100644 examples/SignatureRequestEditEmbeddedWithTemplate.ts create mode 100644 examples/SignatureRequestEditEmbeddedWithTemplateExample.cs create mode 100644 examples/SignatureRequestEditEmbeddedWithTemplateExample.java create mode 100644 examples/SignatureRequestEditEmbeddedWithTemplateExample.php create mode 100644 examples/SignatureRequestEditEmbeddedWithTemplateExample.py create mode 100644 examples/SignatureRequestEditEmbeddedWithTemplateExample.rb rename examples/{SignatureRequestEditEmbeddedWithTemplate.sh => SignatureRequestEditEmbeddedWithTemplateExample.sh} (100%) create mode 100644 examples/SignatureRequestEditEmbeddedWithTemplateExample.ts create mode 100644 examples/SignatureRequestEditExample.cs create mode 100644 examples/SignatureRequestEditExample.java create mode 100644 examples/SignatureRequestEditExample.php rename examples/{UnclaimedDraftCreate.py => SignatureRequestEditExample.py} (52%) create mode 100644 examples/SignatureRequestEditExample.rb rename examples/{SignatureRequestEdit.sh => SignatureRequestEditExample.sh} (100%) create mode 100644 examples/SignatureRequestEditExample.ts create mode 100644 examples/SignatureRequestEditGroupedSignersExample.cs create mode 100644 examples/SignatureRequestEditGroupedSignersExample.java create mode 100644 examples/SignatureRequestEditGroupedSignersExample.php create mode 100644 examples/SignatureRequestEditGroupedSignersExample.py create mode 100644 examples/SignatureRequestEditGroupedSignersExample.rb create mode 100644 examples/SignatureRequestEditGroupedSignersExample.ts delete mode 100644 examples/SignatureRequestEditWithTemplate.cs delete mode 100644 examples/SignatureRequestEditWithTemplate.java delete mode 100644 examples/SignatureRequestEditWithTemplate.js delete mode 100644 examples/SignatureRequestEditWithTemplate.php delete mode 100644 examples/SignatureRequestEditWithTemplate.rb delete mode 100644 examples/SignatureRequestEditWithTemplate.ts create mode 100644 examples/SignatureRequestEditWithTemplateExample.cs create mode 100644 examples/SignatureRequestEditWithTemplateExample.java create mode 100644 examples/SignatureRequestEditWithTemplateExample.php create mode 100644 examples/SignatureRequestEditWithTemplateExample.py create mode 100644 examples/SignatureRequestEditWithTemplateExample.rb rename examples/{SignatureRequestEditWithTemplate.sh => SignatureRequestEditWithTemplateExample.sh} (100%) create mode 100644 examples/SignatureRequestEditWithTemplateExample.ts delete mode 100644 examples/SignatureRequestFiles.cs delete mode 100644 examples/SignatureRequestFiles.java delete mode 100644 examples/SignatureRequestFiles.js delete mode 100644 examples/SignatureRequestFiles.php delete mode 100644 examples/SignatureRequestFiles.py delete mode 100644 examples/SignatureRequestFiles.rb delete mode 100644 examples/SignatureRequestFiles.ts delete mode 100644 examples/SignatureRequestFilesAsDataUri.cs delete mode 100644 examples/SignatureRequestFilesAsDataUri.java delete mode 100644 examples/SignatureRequestFilesAsDataUri.js delete mode 100644 examples/SignatureRequestFilesAsDataUri.php delete mode 100644 examples/SignatureRequestFilesAsDataUri.py delete mode 100644 examples/SignatureRequestFilesAsDataUri.rb delete mode 100644 examples/SignatureRequestFilesAsDataUri.ts create mode 100644 examples/SignatureRequestFilesAsDataUriExample.cs create mode 100644 examples/SignatureRequestFilesAsDataUriExample.java create mode 100644 examples/SignatureRequestFilesAsDataUriExample.php create mode 100644 examples/SignatureRequestFilesAsDataUriExample.py create mode 100644 examples/SignatureRequestFilesAsDataUriExample.rb rename examples/{SignatureRequestFilesAsDataUri.sh => SignatureRequestFilesAsDataUriExample.sh} (100%) create mode 100644 examples/SignatureRequestFilesAsDataUriExample.ts delete mode 100644 examples/SignatureRequestFilesAsFileUrl.cs delete mode 100644 examples/SignatureRequestFilesAsFileUrl.java delete mode 100644 examples/SignatureRequestFilesAsFileUrl.js delete mode 100644 examples/SignatureRequestFilesAsFileUrl.php delete mode 100644 examples/SignatureRequestFilesAsFileUrl.py delete mode 100644 examples/SignatureRequestFilesAsFileUrl.rb delete mode 100644 examples/SignatureRequestFilesAsFileUrl.ts create mode 100644 examples/SignatureRequestFilesAsFileUrlExample.cs create mode 100644 examples/SignatureRequestFilesAsFileUrlExample.java create mode 100644 examples/SignatureRequestFilesAsFileUrlExample.php create mode 100644 examples/SignatureRequestFilesAsFileUrlExample.py create mode 100644 examples/SignatureRequestFilesAsFileUrlExample.rb rename examples/{SignatureRequestFilesAsFileUrl.sh => SignatureRequestFilesAsFileUrlExample.sh} (100%) create mode 100644 examples/SignatureRequestFilesAsFileUrlExample.ts create mode 100644 examples/SignatureRequestFilesExample.cs create mode 100644 examples/SignatureRequestFilesExample.java create mode 100644 examples/SignatureRequestFilesExample.php create mode 100644 examples/SignatureRequestFilesExample.py create mode 100644 examples/SignatureRequestFilesExample.rb rename examples/{SignatureRequestFiles.sh => SignatureRequestFilesExample.sh} (100%) create mode 100644 examples/SignatureRequestFilesExample.ts delete mode 100644 examples/SignatureRequestGet.cs delete mode 100644 examples/SignatureRequestGet.java delete mode 100644 examples/SignatureRequestGet.js delete mode 100644 examples/SignatureRequestGet.php delete mode 100644 examples/SignatureRequestGet.py delete mode 100644 examples/SignatureRequestGet.rb delete mode 100644 examples/SignatureRequestGet.ts create mode 100644 examples/SignatureRequestGetExample.cs create mode 100644 examples/SignatureRequestGetExample.java create mode 100644 examples/SignatureRequestGetExample.php create mode 100644 examples/SignatureRequestGetExample.py create mode 100644 examples/SignatureRequestGetExample.rb rename examples/{SignatureRequestGet.sh => SignatureRequestGetExample.sh} (100%) create mode 100644 examples/SignatureRequestGetExample.ts delete mode 100644 examples/SignatureRequestList.cs delete mode 100644 examples/SignatureRequestList.java delete mode 100644 examples/SignatureRequestList.js delete mode 100644 examples/SignatureRequestList.php delete mode 100644 examples/SignatureRequestList.py delete mode 100644 examples/SignatureRequestList.rb delete mode 100644 examples/SignatureRequestList.ts create mode 100644 examples/SignatureRequestListExample.cs create mode 100644 examples/SignatureRequestListExample.java create mode 100644 examples/SignatureRequestListExample.php create mode 100644 examples/SignatureRequestListExample.py create mode 100644 examples/SignatureRequestListExample.rb rename examples/{SignatureRequestList.sh => SignatureRequestListExample.sh} (100%) create mode 100644 examples/SignatureRequestListExample.ts delete mode 100644 examples/SignatureRequestReleaseHold.cs delete mode 100644 examples/SignatureRequestReleaseHold.java delete mode 100644 examples/SignatureRequestReleaseHold.js delete mode 100644 examples/SignatureRequestReleaseHold.php delete mode 100644 examples/SignatureRequestReleaseHold.py delete mode 100644 examples/SignatureRequestReleaseHold.rb delete mode 100644 examples/SignatureRequestReleaseHold.ts create mode 100644 examples/SignatureRequestReleaseHoldExample.cs create mode 100644 examples/SignatureRequestReleaseHoldExample.java create mode 100644 examples/SignatureRequestReleaseHoldExample.php create mode 100644 examples/SignatureRequestReleaseHoldExample.py create mode 100644 examples/SignatureRequestReleaseHoldExample.rb rename examples/{SignatureRequestReleaseHold.sh => SignatureRequestReleaseHoldExample.sh} (100%) create mode 100644 examples/SignatureRequestReleaseHoldExample.ts delete mode 100644 examples/SignatureRequestRemind.cs delete mode 100644 examples/SignatureRequestRemind.java delete mode 100644 examples/SignatureRequestRemind.js delete mode 100644 examples/SignatureRequestRemind.php delete mode 100644 examples/SignatureRequestRemind.py delete mode 100644 examples/SignatureRequestRemind.rb delete mode 100644 examples/SignatureRequestRemind.ts create mode 100644 examples/SignatureRequestRemindExample.cs create mode 100644 examples/SignatureRequestRemindExample.java create mode 100644 examples/SignatureRequestRemindExample.php create mode 100644 examples/SignatureRequestRemindExample.py create mode 100644 examples/SignatureRequestRemindExample.rb rename examples/{SignatureRequestRemind.sh => SignatureRequestRemindExample.sh} (100%) create mode 100644 examples/SignatureRequestRemindExample.ts delete mode 100644 examples/SignatureRequestRemove.cs delete mode 100644 examples/SignatureRequestRemove.java delete mode 100644 examples/SignatureRequestRemove.js delete mode 100644 examples/SignatureRequestRemove.php delete mode 100644 examples/SignatureRequestRemove.py delete mode 100644 examples/SignatureRequestRemove.rb delete mode 100644 examples/SignatureRequestRemove.ts rename examples/{FaxLineCreate.cs => SignatureRequestRemoveExample.cs} (53%) create mode 100644 examples/SignatureRequestRemoveExample.java create mode 100644 examples/SignatureRequestRemoveExample.php create mode 100644 examples/SignatureRequestRemoveExample.py create mode 100644 examples/SignatureRequestRemoveExample.rb rename examples/{SignatureRequestRemove.sh => SignatureRequestRemoveExample.sh} (100%) create mode 100644 examples/SignatureRequestRemoveExample.ts delete mode 100644 examples/SignatureRequestSend.cs delete mode 100644 examples/SignatureRequestSend.java delete mode 100644 examples/SignatureRequestSend.js delete mode 100644 examples/SignatureRequestSend.php delete mode 100644 examples/SignatureRequestSend.rb delete mode 100644 examples/SignatureRequestSend.ts create mode 100644 examples/SignatureRequestSendExample.cs create mode 100644 examples/SignatureRequestSendExample.java create mode 100644 examples/SignatureRequestSendExample.php rename examples/{SignatureRequestEdit.py => SignatureRequestSendExample.py} (55%) create mode 100644 examples/SignatureRequestSendExample.rb rename examples/{SignatureRequestSend.sh => SignatureRequestSendExample.sh} (100%) create mode 100644 examples/SignatureRequestSendExample.ts create mode 100644 examples/SignatureRequestSendGroupedSignersExample.cs create mode 100644 examples/SignatureRequestSendGroupedSignersExample.java create mode 100644 examples/SignatureRequestSendGroupedSignersExample.php create mode 100644 examples/SignatureRequestSendGroupedSignersExample.py create mode 100644 examples/SignatureRequestSendGroupedSignersExample.rb create mode 100644 examples/SignatureRequestSendGroupedSignersExample.ts delete mode 100644 examples/SignatureRequestSendWithTemplate.cs delete mode 100644 examples/SignatureRequestSendWithTemplate.java delete mode 100644 examples/SignatureRequestSendWithTemplate.js delete mode 100644 examples/SignatureRequestSendWithTemplate.php delete mode 100644 examples/SignatureRequestSendWithTemplate.rb delete mode 100644 examples/SignatureRequestSendWithTemplate.ts create mode 100644 examples/SignatureRequestSendWithTemplateExample.cs create mode 100644 examples/SignatureRequestSendWithTemplateExample.java create mode 100644 examples/SignatureRequestSendWithTemplateExample.php rename examples/{SignatureRequestEditWithTemplate.py => SignatureRequestSendWithTemplateExample.py} (50%) create mode 100644 examples/SignatureRequestSendWithTemplateExample.rb rename examples/{SignatureRequestSendWithTemplate.sh => SignatureRequestSendWithTemplateExample.sh} (100%) create mode 100644 examples/SignatureRequestSendWithTemplateExample.ts delete mode 100644 examples/SignatureRequestUpdate.cs delete mode 100644 examples/SignatureRequestUpdate.java delete mode 100644 examples/SignatureRequestUpdate.js delete mode 100644 examples/SignatureRequestUpdate.php delete mode 100644 examples/SignatureRequestUpdate.py delete mode 100644 examples/SignatureRequestUpdate.rb delete mode 100644 examples/SignatureRequestUpdate.ts create mode 100644 examples/SignatureRequestUpdateExample.cs create mode 100644 examples/SignatureRequestUpdateExample.java create mode 100644 examples/SignatureRequestUpdateExample.php create mode 100644 examples/SignatureRequestUpdateExample.py create mode 100644 examples/SignatureRequestUpdateExample.rb rename examples/{SignatureRequestUpdate.sh => SignatureRequestUpdateExample.sh} (100%) create mode 100644 examples/SignatureRequestUpdateExample.ts delete mode 100644 examples/TeamAddMember.cs delete mode 100644 examples/TeamAddMember.java delete mode 100644 examples/TeamAddMember.js delete mode 100644 examples/TeamAddMember.php delete mode 100644 examples/TeamAddMember.py delete mode 100644 examples/TeamAddMember.rb delete mode 100644 examples/TeamAddMember.ts create mode 100644 examples/TeamAddMemberAccountIdExample.cs create mode 100644 examples/TeamAddMemberAccountIdExample.java create mode 100644 examples/TeamAddMemberAccountIdExample.php create mode 100644 examples/TeamAddMemberAccountIdExample.py create mode 100644 examples/TeamAddMemberAccountIdExample.rb create mode 100644 examples/TeamAddMemberAccountIdExample.ts create mode 100644 examples/TeamAddMemberExample.cs create mode 100644 examples/TeamAddMemberExample.java create mode 100644 examples/TeamAddMemberExample.php create mode 100644 examples/TeamAddMemberExample.py create mode 100644 examples/TeamAddMemberExample.rb rename examples/{TeamAddMember.sh => TeamAddMemberExample.sh} (100%) create mode 100644 examples/TeamAddMemberExample.ts delete mode 100644 examples/TeamCreate.cs delete mode 100644 examples/TeamCreate.java delete mode 100644 examples/TeamCreate.js delete mode 100644 examples/TeamCreate.php delete mode 100644 examples/TeamCreate.rb delete mode 100644 examples/TeamCreate.ts create mode 100644 examples/TeamCreateExample.cs create mode 100644 examples/TeamCreateExample.java create mode 100644 examples/TeamCreateExample.php rename examples/{TeamUpdate.py => TeamCreateExample.py} (52%) create mode 100644 examples/TeamCreateExample.rb rename examples/{TeamCreate.sh => TeamCreateExample.sh} (100%) create mode 100644 examples/TeamCreateExample.ts delete mode 100644 examples/TeamDelete.cs delete mode 100644 examples/TeamDelete.java delete mode 100644 examples/TeamDelete.js delete mode 100644 examples/TeamDelete.php delete mode 100644 examples/TeamDelete.rb delete mode 100644 examples/TeamDelete.ts rename examples/{FaxDelete.cs => TeamDeleteExample.cs} (58%) create mode 100644 examples/TeamDeleteExample.java create mode 100644 examples/TeamDeleteExample.php rename examples/{TeamDelete.py => TeamDeleteExample.py} (50%) create mode 100644 examples/TeamDeleteExample.rb rename examples/{TeamDelete.sh => TeamDeleteExample.sh} (100%) create mode 100644 examples/TeamDeleteExample.ts delete mode 100644 examples/TeamGet.cs delete mode 100644 examples/TeamGet.java delete mode 100644 examples/TeamGet.js delete mode 100644 examples/TeamGet.php delete mode 100644 examples/TeamGet.rb delete mode 100644 examples/TeamGet.ts rename examples/{FaxLineAreaCodeGet.cs => TeamGetExample.cs} (55%) create mode 100644 examples/TeamGetExample.java create mode 100644 examples/TeamGetExample.php rename examples/{TeamGet.py => TeamGetExample.py} (54%) create mode 100644 examples/TeamGetExample.rb rename examples/{TeamGet.sh => TeamGetExample.sh} (100%) create mode 100644 examples/TeamGetExample.ts delete mode 100644 examples/TeamInfo.cs delete mode 100644 examples/TeamInfo.java delete mode 100644 examples/TeamInfo.js delete mode 100644 examples/TeamInfo.php delete mode 100644 examples/TeamInfo.rb delete mode 100644 examples/TeamInfo.ts create mode 100644 examples/TeamInfoExample.cs create mode 100644 examples/TeamInfoExample.java create mode 100644 examples/TeamInfoExample.php create mode 100644 examples/TeamInfoExample.py create mode 100644 examples/TeamInfoExample.rb rename examples/{TeamInfo.sh => TeamInfoExample.sh} (100%) create mode 100644 examples/TeamInfoExample.ts delete mode 100644 examples/TeamInvites.cs delete mode 100644 examples/TeamInvites.java delete mode 100644 examples/TeamInvites.js delete mode 100644 examples/TeamInvites.php delete mode 100644 examples/TeamInvites.py delete mode 100644 examples/TeamInvites.rb delete mode 100644 examples/TeamInvites.ts create mode 100644 examples/TeamInvitesExample.cs create mode 100644 examples/TeamInvitesExample.java create mode 100644 examples/TeamInvitesExample.php rename examples/{FaxLineList.py => TeamInvitesExample.py} (53%) create mode 100644 examples/TeamInvitesExample.rb rename examples/{TeamInvites.sh => TeamInvitesExample.sh} (100%) create mode 100644 examples/TeamInvitesExample.ts delete mode 100644 examples/TeamMembers.cs delete mode 100644 examples/TeamMembers.java delete mode 100644 examples/TeamMembers.js delete mode 100644 examples/TeamMembers.php delete mode 100644 examples/TeamMembers.py delete mode 100644 examples/TeamMembers.rb delete mode 100644 examples/TeamMembers.ts create mode 100644 examples/TeamMembersExample.cs create mode 100644 examples/TeamMembersExample.java create mode 100644 examples/TeamMembersExample.php create mode 100644 examples/TeamMembersExample.py create mode 100644 examples/TeamMembersExample.rb rename examples/{TeamMembers.sh => TeamMembersExample.sh} (100%) create mode 100644 examples/TeamMembersExample.ts delete mode 100644 examples/TeamRemoveMember.java delete mode 100644 examples/TeamRemoveMember.js delete mode 100644 examples/TeamRemoveMember.php delete mode 100644 examples/TeamRemoveMember.rb delete mode 100644 examples/TeamRemoveMember.ts create mode 100644 examples/TeamRemoveMemberAccountIdExample.cs create mode 100644 examples/TeamRemoveMemberAccountIdExample.java create mode 100644 examples/TeamRemoveMemberAccountIdExample.php create mode 100644 examples/TeamRemoveMemberAccountIdExample.py create mode 100644 examples/TeamRemoveMemberAccountIdExample.rb create mode 100644 examples/TeamRemoveMemberAccountIdExample.ts rename examples/{TeamRemoveMember.cs => TeamRemoveMemberExample.cs} (50%) create mode 100644 examples/TeamRemoveMemberExample.java create mode 100644 examples/TeamRemoveMemberExample.php rename examples/{TeamRemoveMember.py => TeamRemoveMemberExample.py} (55%) create mode 100644 examples/TeamRemoveMemberExample.rb rename examples/{TeamRemoveMember.sh => TeamRemoveMemberExample.sh} (100%) create mode 100644 examples/TeamRemoveMemberExample.ts delete mode 100644 examples/TeamSubTeams.cs delete mode 100644 examples/TeamSubTeams.java delete mode 100644 examples/TeamSubTeams.js delete mode 100644 examples/TeamSubTeams.php delete mode 100644 examples/TeamSubTeams.py delete mode 100644 examples/TeamSubTeams.rb delete mode 100644 examples/TeamSubTeams.ts create mode 100644 examples/TeamSubTeamsExample.cs create mode 100644 examples/TeamSubTeamsExample.java create mode 100644 examples/TeamSubTeamsExample.php create mode 100644 examples/TeamSubTeamsExample.py create mode 100644 examples/TeamSubTeamsExample.rb rename examples/{TeamSubTeams.sh => TeamSubTeamsExample.sh} (100%) create mode 100644 examples/TeamSubTeamsExample.ts delete mode 100644 examples/TeamUpdate.cs delete mode 100644 examples/TeamUpdate.java delete mode 100644 examples/TeamUpdate.js delete mode 100644 examples/TeamUpdate.php delete mode 100644 examples/TeamUpdate.rb delete mode 100644 examples/TeamUpdate.ts create mode 100644 examples/TeamUpdateExample.cs create mode 100644 examples/TeamUpdateExample.java create mode 100644 examples/TeamUpdateExample.php rename examples/{TeamCreate.py => TeamUpdateExample.py} (52%) create mode 100644 examples/TeamUpdateExample.rb rename examples/{TeamUpdate.sh => TeamUpdateExample.sh} (100%) create mode 100644 examples/TeamUpdateExample.ts delete mode 100644 examples/TemplateAddUser.cs delete mode 100644 examples/TemplateAddUser.java delete mode 100644 examples/TemplateAddUser.js delete mode 100644 examples/TemplateAddUser.php delete mode 100644 examples/TemplateAddUser.py delete mode 100644 examples/TemplateAddUser.rb delete mode 100644 examples/TemplateAddUser.ts create mode 100644 examples/TemplateAddUserExample.cs create mode 100644 examples/TemplateAddUserExample.java create mode 100644 examples/TemplateAddUserExample.php create mode 100644 examples/TemplateAddUserExample.py create mode 100644 examples/TemplateAddUserExample.rb rename examples/{TemplateAddUser.sh => TemplateAddUserExample.sh} (100%) create mode 100644 examples/TemplateAddUserExample.ts delete mode 100644 examples/TemplateCreate.cs delete mode 100644 examples/TemplateCreate.java delete mode 100644 examples/TemplateCreate.js delete mode 100644 examples/TemplateCreate.php delete mode 100644 examples/TemplateCreate.py delete mode 100644 examples/TemplateCreate.rb delete mode 100644 examples/TemplateCreate.ts delete mode 100644 examples/TemplateCreateEmbeddedDraft.cs delete mode 100644 examples/TemplateCreateEmbeddedDraft.java delete mode 100644 examples/TemplateCreateEmbeddedDraft.js delete mode 100644 examples/TemplateCreateEmbeddedDraft.php delete mode 100644 examples/TemplateCreateEmbeddedDraft.py delete mode 100644 examples/TemplateCreateEmbeddedDraft.rb delete mode 100644 examples/TemplateCreateEmbeddedDraft.ts create mode 100644 examples/TemplateCreateEmbeddedDraftExample.cs create mode 100644 examples/TemplateCreateEmbeddedDraftExample.java create mode 100644 examples/TemplateCreateEmbeddedDraftExample.php create mode 100644 examples/TemplateCreateEmbeddedDraftExample.py create mode 100644 examples/TemplateCreateEmbeddedDraftExample.rb rename examples/{TemplateCreateEmbeddedDraft.sh => TemplateCreateEmbeddedDraftExample.sh} (100%) create mode 100644 examples/TemplateCreateEmbeddedDraftExample.ts create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb create mode 100644 examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts create mode 100644 examples/TemplateCreateExample.cs create mode 100644 examples/TemplateCreateExample.java create mode 100644 examples/TemplateCreateExample.php create mode 100644 examples/TemplateCreateExample.py create mode 100644 examples/TemplateCreateExample.rb rename examples/{TemplateCreate.sh => TemplateCreateExample.sh} (100%) create mode 100644 examples/TemplateCreateExample.ts create mode 100644 examples/TemplateCreateFormFieldGroupsExample.cs create mode 100644 examples/TemplateCreateFormFieldGroupsExample.java create mode 100644 examples/TemplateCreateFormFieldGroupsExample.php create mode 100644 examples/TemplateCreateFormFieldGroupsExample.py create mode 100644 examples/TemplateCreateFormFieldGroupsExample.rb create mode 100644 examples/TemplateCreateFormFieldGroupsExample.ts create mode 100644 examples/TemplateCreateFormFieldRulesExample.cs create mode 100644 examples/TemplateCreateFormFieldRulesExample.java create mode 100644 examples/TemplateCreateFormFieldRulesExample.php create mode 100644 examples/TemplateCreateFormFieldRulesExample.py create mode 100644 examples/TemplateCreateFormFieldRulesExample.rb create mode 100644 examples/TemplateCreateFormFieldRulesExample.ts create mode 100644 examples/TemplateCreateFormFieldsPerDocumentExample.cs create mode 100644 examples/TemplateCreateFormFieldsPerDocumentExample.java create mode 100644 examples/TemplateCreateFormFieldsPerDocumentExample.php create mode 100644 examples/TemplateCreateFormFieldsPerDocumentExample.py create mode 100644 examples/TemplateCreateFormFieldsPerDocumentExample.rb create mode 100644 examples/TemplateCreateFormFieldsPerDocumentExample.ts delete mode 100644 examples/TemplateDelete.cs delete mode 100644 examples/TemplateDelete.java delete mode 100644 examples/TemplateDelete.js delete mode 100644 examples/TemplateDelete.php delete mode 100644 examples/TemplateDelete.py delete mode 100644 examples/TemplateDelete.rb delete mode 100644 examples/TemplateDelete.ts create mode 100644 examples/TemplateDeleteExample.cs create mode 100644 examples/TemplateDeleteExample.java create mode 100644 examples/TemplateDeleteExample.php create mode 100644 examples/TemplateDeleteExample.py create mode 100644 examples/TemplateDeleteExample.rb rename examples/{TemplateDelete.sh => TemplateDeleteExample.sh} (100%) create mode 100644 examples/TemplateDeleteExample.ts delete mode 100644 examples/TemplateFiles.cs delete mode 100644 examples/TemplateFiles.java delete mode 100644 examples/TemplateFiles.js delete mode 100644 examples/TemplateFiles.php delete mode 100644 examples/TemplateFiles.py delete mode 100644 examples/TemplateFiles.rb delete mode 100644 examples/TemplateFiles.ts delete mode 100644 examples/TemplateFilesAsDataUri.cs delete mode 100644 examples/TemplateFilesAsDataUri.java delete mode 100644 examples/TemplateFilesAsDataUri.js delete mode 100644 examples/TemplateFilesAsDataUri.php delete mode 100644 examples/TemplateFilesAsDataUri.py delete mode 100644 examples/TemplateFilesAsDataUri.rb delete mode 100644 examples/TemplateFilesAsDataUri.ts create mode 100644 examples/TemplateFilesAsDataUriExample.cs create mode 100644 examples/TemplateFilesAsDataUriExample.java create mode 100644 examples/TemplateFilesAsDataUriExample.php create mode 100644 examples/TemplateFilesAsDataUriExample.py create mode 100644 examples/TemplateFilesAsDataUriExample.rb rename examples/{TemplateFilesAsDataUri.sh => TemplateFilesAsDataUriExample.sh} (100%) create mode 100644 examples/TemplateFilesAsDataUriExample.ts delete mode 100644 examples/TemplateFilesAsFileUrl.cs delete mode 100644 examples/TemplateFilesAsFileUrl.java delete mode 100644 examples/TemplateFilesAsFileUrl.js delete mode 100644 examples/TemplateFilesAsFileUrl.php delete mode 100644 examples/TemplateFilesAsFileUrl.py delete mode 100644 examples/TemplateFilesAsFileUrl.rb delete mode 100644 examples/TemplateFilesAsFileUrl.ts create mode 100644 examples/TemplateFilesAsFileUrlExample.cs create mode 100644 examples/TemplateFilesAsFileUrlExample.java create mode 100644 examples/TemplateFilesAsFileUrlExample.php create mode 100644 examples/TemplateFilesAsFileUrlExample.py create mode 100644 examples/TemplateFilesAsFileUrlExample.rb rename examples/{TemplateFilesAsFileUrl.sh => TemplateFilesAsFileUrlExample.sh} (100%) create mode 100644 examples/TemplateFilesAsFileUrlExample.ts create mode 100644 examples/TemplateFilesExample.cs create mode 100644 examples/TemplateFilesExample.java create mode 100644 examples/TemplateFilesExample.php create mode 100644 examples/TemplateFilesExample.py create mode 100644 examples/TemplateFilesExample.rb rename examples/{TemplateFiles.sh => TemplateFilesExample.sh} (100%) create mode 100644 examples/TemplateFilesExample.ts delete mode 100644 examples/TemplateGet.cs delete mode 100644 examples/TemplateGet.java delete mode 100644 examples/TemplateGet.js delete mode 100644 examples/TemplateGet.php delete mode 100644 examples/TemplateGet.py delete mode 100644 examples/TemplateGet.rb delete mode 100644 examples/TemplateGet.ts create mode 100644 examples/TemplateGetExample.cs create mode 100644 examples/TemplateGetExample.java create mode 100644 examples/TemplateGetExample.php create mode 100644 examples/TemplateGetExample.py create mode 100644 examples/TemplateGetExample.rb rename examples/{TemplateGet.sh => TemplateGetExample.sh} (100%) create mode 100644 examples/TemplateGetExample.ts delete mode 100644 examples/TemplateList.cs delete mode 100644 examples/TemplateList.java delete mode 100644 examples/TemplateList.js delete mode 100644 examples/TemplateList.php delete mode 100644 examples/TemplateList.py delete mode 100644 examples/TemplateList.rb delete mode 100644 examples/TemplateList.ts create mode 100644 examples/TemplateListExample.cs create mode 100644 examples/TemplateListExample.java create mode 100644 examples/TemplateListExample.php create mode 100644 examples/TemplateListExample.py create mode 100644 examples/TemplateListExample.rb rename examples/{TemplateList.sh => TemplateListExample.sh} (100%) create mode 100644 examples/TemplateListExample.ts delete mode 100644 examples/TemplateRemoveUser.cs delete mode 100644 examples/TemplateRemoveUser.java delete mode 100644 examples/TemplateRemoveUser.js delete mode 100644 examples/TemplateRemoveUser.php delete mode 100644 examples/TemplateRemoveUser.py delete mode 100644 examples/TemplateRemoveUser.rb delete mode 100644 examples/TemplateRemoveUser.ts create mode 100644 examples/TemplateRemoveUserExample.cs create mode 100644 examples/TemplateRemoveUserExample.java create mode 100644 examples/TemplateRemoveUserExample.php create mode 100644 examples/TemplateRemoveUserExample.py create mode 100644 examples/TemplateRemoveUserExample.rb rename examples/{TemplateRemoveUser.sh => TemplateRemoveUserExample.sh} (100%) create mode 100644 examples/TemplateRemoveUserExample.ts delete mode 100644 examples/TemplateUpdateFiles.cs delete mode 100644 examples/TemplateUpdateFiles.java delete mode 100644 examples/TemplateUpdateFiles.js delete mode 100644 examples/TemplateUpdateFiles.php delete mode 100644 examples/TemplateUpdateFiles.py delete mode 100644 examples/TemplateUpdateFiles.rb delete mode 100644 examples/TemplateUpdateFiles.ts create mode 100644 examples/TemplateUpdateFilesExample.cs create mode 100644 examples/TemplateUpdateFilesExample.java create mode 100644 examples/TemplateUpdateFilesExample.php create mode 100644 examples/TemplateUpdateFilesExample.py create mode 100644 examples/TemplateUpdateFilesExample.rb rename examples/{TemplateUpdateFiles.sh => TemplateUpdateFilesExample.sh} (100%) create mode 100644 examples/TemplateUpdateFilesExample.ts delete mode 100644 examples/UnclaimedDraftCreate.cs delete mode 100644 examples/UnclaimedDraftCreate.java delete mode 100644 examples/UnclaimedDraftCreate.js delete mode 100644 examples/UnclaimedDraftCreate.php delete mode 100644 examples/UnclaimedDraftCreate.rb delete mode 100644 examples/UnclaimedDraftCreate.ts delete mode 100644 examples/UnclaimedDraftCreateEmbedded.cs delete mode 100644 examples/UnclaimedDraftCreateEmbedded.java delete mode 100644 examples/UnclaimedDraftCreateEmbedded.js delete mode 100644 examples/UnclaimedDraftCreateEmbedded.php delete mode 100644 examples/UnclaimedDraftCreateEmbedded.py delete mode 100644 examples/UnclaimedDraftCreateEmbedded.rb delete mode 100644 examples/UnclaimedDraftCreateEmbedded.ts create mode 100644 examples/UnclaimedDraftCreateEmbeddedExample.cs create mode 100644 examples/UnclaimedDraftCreateEmbeddedExample.java create mode 100644 examples/UnclaimedDraftCreateEmbeddedExample.php create mode 100644 examples/UnclaimedDraftCreateEmbeddedExample.py create mode 100644 examples/UnclaimedDraftCreateEmbeddedExample.rb rename examples/{UnclaimedDraftCreateEmbedded.sh => UnclaimedDraftCreateEmbeddedExample.sh} (100%) create mode 100644 examples/UnclaimedDraftCreateEmbeddedExample.ts create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb create mode 100644 examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.java delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.js delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.php delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.py delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb delete mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts create mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs create mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java create mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php create mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py create mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb rename examples/{UnclaimedDraftCreateEmbeddedWithTemplate.sh => UnclaimedDraftCreateEmbeddedWithTemplateExample.sh} (100%) create mode 100644 examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts create mode 100644 examples/UnclaimedDraftCreateExample.cs create mode 100644 examples/UnclaimedDraftCreateExample.java create mode 100644 examples/UnclaimedDraftCreateExample.php create mode 100644 examples/UnclaimedDraftCreateExample.py create mode 100644 examples/UnclaimedDraftCreateExample.rb rename examples/{UnclaimedDraftCreate.sh => UnclaimedDraftCreateExample.sh} (100%) create mode 100644 examples/UnclaimedDraftCreateExample.ts create mode 100644 examples/UnclaimedDraftCreateFormFieldGroupsExample.cs create mode 100644 examples/UnclaimedDraftCreateFormFieldGroupsExample.java create mode 100644 examples/UnclaimedDraftCreateFormFieldGroupsExample.php create mode 100644 examples/UnclaimedDraftCreateFormFieldGroupsExample.py create mode 100644 examples/UnclaimedDraftCreateFormFieldGroupsExample.rb create mode 100644 examples/UnclaimedDraftCreateFormFieldGroupsExample.ts create mode 100644 examples/UnclaimedDraftCreateFormFieldRulesExample.cs create mode 100644 examples/UnclaimedDraftCreateFormFieldRulesExample.java create mode 100644 examples/UnclaimedDraftCreateFormFieldRulesExample.php create mode 100644 examples/UnclaimedDraftCreateFormFieldRulesExample.py create mode 100644 examples/UnclaimedDraftCreateFormFieldRulesExample.rb create mode 100644 examples/UnclaimedDraftCreateFormFieldRulesExample.ts create mode 100644 examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs create mode 100644 examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java create mode 100644 examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php create mode 100644 examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py create mode 100644 examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb create mode 100644 examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts delete mode 100644 examples/UnclaimedDraftEditAndResend.cs delete mode 100644 examples/UnclaimedDraftEditAndResend.java delete mode 100644 examples/UnclaimedDraftEditAndResend.js delete mode 100644 examples/UnclaimedDraftEditAndResend.php delete mode 100644 examples/UnclaimedDraftEditAndResend.py delete mode 100644 examples/UnclaimedDraftEditAndResend.rb delete mode 100644 examples/UnclaimedDraftEditAndResend.ts create mode 100644 examples/UnclaimedDraftEditAndResendExample.cs create mode 100644 examples/UnclaimedDraftEditAndResendExample.java create mode 100644 examples/UnclaimedDraftEditAndResendExample.php create mode 100644 examples/UnclaimedDraftEditAndResendExample.py create mode 100644 examples/UnclaimedDraftEditAndResendExample.rb rename examples/{UnclaimedDraftEditAndResend.sh => UnclaimedDraftEditAndResendExample.sh} (100%) create mode 100644 examples/UnclaimedDraftEditAndResendExample.ts rename examples/json/{AccountCreateOAuthResponseExample.json => AccountCreateOAuthResponse.json} (100%) rename examples/json/{AccountCreateRequestDefaultExample.json => AccountCreateRequest.json} (100%) rename examples/json/{AccountCreateRequestOAuthExample.json => AccountCreateRequestOAuth.json} (100%) rename examples/json/{AccountCreateResponseExample.json => AccountCreateResponse.json} (100%) rename examples/json/{AccountGetResponseExample.json => AccountGetResponse.json} (100%) rename examples/json/{AccountUpdateRequestDefaultExample.json => AccountUpdateRequest.json} (100%) rename examples/json/{AccountUpdateResponseExample.json => AccountUpdateResponse.json} (100%) rename examples/json/{AccountVerifyFoundResponseExample.json => AccountVerifyFoundResponse.json} (100%) rename examples/json/{AccountVerifyNotFoundResponseExample.json => AccountVerifyNotFoundResponse.json} (100%) rename examples/json/{AccountVerifyRequestDefaultExample.json => AccountVerifyRequest.json} (100%) rename examples/json/{ApiAppCreateRequestDefaultExample.json => ApiAppCreateRequest.json} (88%) rename examples/json/{ApiAppCreateResponseExample.json => ApiAppCreateResponse.json} (100%) rename examples/json/{ApiAppGetResponseExample.json => ApiAppGetResponse.json} (100%) rename examples/json/{ApiAppListResponseExample.json => ApiAppListResponse.json} (100%) create mode 100644 examples/json/ApiAppUpdateRequest.json delete mode 100644 examples/json/ApiAppUpdateRequestDefaultExample.json rename examples/json/{ApiAppUpdateResponseExample.json => ApiAppUpdateResponse.json} (100%) rename examples/json/{BulkSendJobGetResponseExample.json => BulkSendJobGetResponse.json} (100%) rename examples/json/{BulkSendJobListResponseExample.json => BulkSendJobListResponse.json} (100%) rename examples/json/{EmbeddedEditUrlRequestDefaultExample.json => EmbeddedEditUrlRequest.json} (100%) rename examples/json/{EmbeddedEditUrlResponseExample.json => EmbeddedEditUrlResponse.json} (100%) rename examples/json/{EmbeddedSignUrlResponseExample.json => EmbeddedSignUrlResponse.json} (100%) rename examples/json/{Error400ResponseExample.json => Error400Response.json} (100%) rename examples/json/{Error401ResponseExample.json => Error401Response.json} (100%) rename examples/json/{Error402ResponseExample.json => Error402Response.json} (100%) rename examples/json/{Error403ResponseExample.json => Error403Response.json} (100%) rename examples/json/{Error404ResponseExample.json => Error404Response.json} (100%) rename examples/json/{Error409ResponseExample.json => Error409Response.json} (100%) rename examples/json/{Error410ResponseExample.json => Error410Response.json} (100%) rename examples/json/{Error422ResponseExample.json => Error422Response.json} (100%) rename examples/json/{Error429ResponseExample.json => Error429Response.json} (100%) rename examples/json/{Error4XXResponseExample.json => Error4XXResponse.json} (100%) rename examples/json/{EventCallbackAccountSignatureRequestSentExample.json => EventCallbackAccountSignatureRequestSent.json} (100%) rename examples/json/{EventCallbackAccountTemplateCreatedExample.json => EventCallbackAccountTemplateCreated.json} (100%) rename examples/json/{EventCallbackAppAccountConfirmedExample.json => EventCallbackAppAccountConfirmed.json} (100%) rename examples/json/{EventCallbackAppSignatureRequestSentExample.json => EventCallbackAppSignatureRequestSent.json} (100%) rename examples/json/{EventCallbackAppTemplateCreatedExample.json => EventCallbackAppTemplateCreated.json} (100%) rename examples/json/{FaxGetResponseExample.json => FaxGetResponse.json} (100%) rename examples/json/{FaxLineAddUserRequestExample.json => FaxLineAddUserRequest.json} (100%) rename examples/json/{FaxLineAreaCodeGetResponseExample.json => FaxLineAreaCodeGetResponse.json} (100%) rename examples/json/{FaxLineCreateRequestExample.json => FaxLineCreateRequest.json} (100%) rename examples/json/{FaxLineDeleteRequestExample.json => FaxLineDeleteRequest.json} (100%) rename examples/json/{FaxLineListResponseExample.json => FaxLineListResponse.json} (100%) rename examples/json/{FaxLineRemoveUserRequestExample.json => FaxLineRemoveUserRequest.json} (100%) rename examples/json/{FaxLineResponseExample.json => FaxLineResponse.json} (100%) rename examples/json/{FaxListResponseExample.json => FaxListResponse.json} (100%) rename examples/json/{FaxSendRequestExample.json => FaxSendRequest.json} (71%) rename examples/json/{OAuthTokenGenerateRequestExample.json => OAuthTokenGenerateRequest.json} (100%) rename examples/json/{OAuthTokenGenerateResponseExample.json => OAuthTokenGenerateResponse.json} (100%) rename examples/json/{OAuthTokenRefreshRequestExample.json => OAuthTokenRefreshRequest.json} (100%) rename examples/json/{OAuthTokenRefreshResponseExample.json => OAuthTokenRefreshResponse.json} (100%) rename examples/json/{ReportCreateRequestDefaultExample.json => ReportCreateRequest.json} (100%) rename examples/json/{ReportCreateResponseExample.json => ReportCreateResponse.json} (100%) rename examples/json/{SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json => SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json} (100%) rename examples/json/{SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json => SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormData.json} (100%) rename examples/json/{SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json => SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json} (100%) rename examples/json/{SignatureRequestBulkSendWithTemplateRequestDefaultExample.json => SignatureRequestBulkSendWithTemplateRequest.json} (100%) rename examples/json/{SignatureRequestBulkSendWithTemplateRequestFormDataExample.json => SignatureRequestBulkSendWithTemplateRequestFormData.json} (100%) rename examples/json/{SignatureRequestBulkSendWithTemplateResponseExample.json => SignatureRequestBulkSendWithTemplateResponse.json} (100%) rename examples/json/{SignatureRequestEditEmbeddedRequestDefaultExample.json => SignatureRequestCreateEmbeddedRequest.json} (88%) rename examples/json/{SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json => SignatureRequestCreateEmbeddedRequestGroupedSigners.json} (100%) rename examples/json/{SignatureRequestCreateEmbeddedResponseExample.json => SignatureRequestCreateEmbeddedResponse.json} (100%) rename examples/json/{SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json => SignatureRequestCreateEmbeddedWithTemplateRequest.json} (100%) rename examples/json/{SignatureRequestCreateEmbeddedWithTemplateResponseExample.json => SignatureRequestCreateEmbeddedWithTemplateResponse.json} (100%) rename examples/json/{SignatureRequestCreateEmbeddedRequestDefaultExample.json => SignatureRequestEditEmbeddedRequest.json} (88%) rename examples/json/{SignatureRequestEditEmbeddedRequestGroupedSignersExample.json => SignatureRequestEditEmbeddedRequestGroupedSigners.json} (100%) rename examples/json/{SignatureRequestEditEmbeddedResponseExample.json => SignatureRequestEditEmbeddedResponse.json} (100%) rename examples/json/{SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json => SignatureRequestEditEmbeddedWithTemplateRequest.json} (100%) rename examples/json/{SignatureRequestEditEmbeddedWithTemplateResponseExample.json => SignatureRequestEditEmbeddedWithTemplateResponse.json} (100%) rename examples/json/{SignatureRequestEditRequestDefaultExample.json => SignatureRequestEditRequest.json} (89%) rename examples/json/{SignatureRequestEditRequestGroupedSignersExample.json => SignatureRequestEditRequestGroupedSigners.json} (100%) rename examples/json/{SignatureRequestEditResponseExample.json => SignatureRequestEditResponse.json} (100%) rename examples/json/{SignatureRequestEditWithTemplateRequestDefaultExample.json => SignatureRequestEditWithTemplateRequest.json} (100%) rename examples/json/{SignatureRequestEditWithTemplateResponseExample.json => SignatureRequestEditWithTemplateResponse.json} (100%) rename examples/json/{SignatureRequestFilesResponseExample.json => SignatureRequestFilesResponse.json} (100%) rename examples/json/{SignatureRequestGetResponseExample.json => SignatureRequestGetResponse.json} (100%) rename examples/json/{SignatureRequestListResponseExample.json => SignatureRequestListResponse.json} (100%) rename examples/json/{SignatureRequestReleaseHoldResponseExample.json => SignatureRequestReleaseHoldResponse.json} (100%) rename examples/json/{SignatureRequestRemindRequestDefaultExample.json => SignatureRequestRemindRequest.json} (100%) rename examples/json/{SignatureRequestRemindResponseExample.json => SignatureRequestRemindResponse.json} (100%) rename examples/json/{SignatureRequestSendRequestDefaultExample.json => SignatureRequestSendRequest.json} (89%) rename examples/json/{SignatureRequestSendRequestGroupedSignersExample.json => SignatureRequestSendRequestGroupedSigners.json} (100%) rename examples/json/{SignatureRequestSendResponseExample.json => SignatureRequestSendResponse.json} (100%) rename examples/json/{SignatureRequestSendWithTemplateRequestDefaultExample.json => SignatureRequestSendWithTemplateRequest.json} (100%) rename examples/json/{SignatureRequestSendWithTemplateResponseExample.json => SignatureRequestSendWithTemplateResponse.json} (100%) rename examples/json/{SignatureRequestUpdateRequestDefaultExample.json => SignatureRequestUpdateRequest.json} (100%) rename examples/json/{SignatureRequestUpdateResponseExample.json => SignatureRequestUpdateResponse.json} (100%) rename examples/json/{TeamAddMemberRequestEmailAddressExample.json => TeamAddMemberRequest.json} (100%) rename examples/json/{TeamAddMemberRequestAccountIdExample.json => TeamAddMemberRequestAccountId.json} (100%) rename examples/json/{TeamAddMemberResponseExample.json => TeamAddMemberResponse.json} (100%) rename examples/json/{TeamCreateRequestDefaultExample.json => TeamCreateRequest.json} (100%) rename examples/json/{TeamCreateResponseExample.json => TeamCreateResponse.json} (100%) rename examples/json/{TeamDoesNotExistResponseExample.json => TeamDoesNotExistResponse.json} (100%) rename examples/json/{TeamGetInfoResponseExample.json => TeamGetInfoResponse.json} (100%) rename examples/json/{TeamGetResponseExample.json => TeamGetResponse.json} (100%) rename examples/json/{TeamGetRootInfoResponseExample.json => TeamGetRootInfoResponse.json} (100%) rename examples/json/{TeamInvitesResponseExample.json => TeamInvitesResponse.json} (100%) rename examples/json/{TeamMembersResponseExample.json => TeamMembersResponse.json} (100%) rename examples/json/{TeamRemoveMemberRequestEmailAddressExample.json => TeamRemoveMemberRequest.json} (100%) rename examples/json/{TeamRemoveMemberRequestAccountIdExample.json => TeamRemoveMemberRequestAccountId.json} (100%) rename examples/json/{TeamRemoveMemberResponseExample.json => TeamRemoveMemberResponse.json} (100%) rename examples/json/{TeamSubTeamsResponseExample.json => TeamSubTeamsResponse.json} (100%) rename examples/json/{TeamUpdateRequestDefaultExample.json => TeamUpdateRequest.json} (100%) rename examples/json/{TeamUpdateResponseExample.json => TeamUpdateResponse.json} (100%) rename examples/json/{TemplateAddUserRequestDefaultExample.json => TemplateAddUserRequest.json} (100%) rename examples/json/{TemplateAddUserResponseExample.json => TemplateAddUserResponse.json} (100%) rename examples/json/{TemplateCreateEmbeddedDraftRequestDefaultExample.json => TemplateCreateEmbeddedDraftRequest.json} (85%) rename examples/json/{TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json => TemplateCreateEmbeddedDraftRequestFormFieldGroups.json} (100%) rename examples/json/{TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json => TemplateCreateEmbeddedDraftRequestFormFieldRules.json} (100%) rename examples/json/{TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json => TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json} (100%) rename examples/json/{TemplateCreateEmbeddedDraftResponseExample.json => TemplateCreateEmbeddedDraftResponse.json} (100%) rename examples/json/{TemplateCreateRequestFormFieldsPerDocumentExample.json => TemplateCreateRequest.json} (92%) rename examples/json/{TemplateCreateRequestFormFieldGroupsExample.json => TemplateCreateRequestFormFieldGroups.json} (100%) rename examples/json/{TemplateCreateRequestFormFieldRulesExample.json => TemplateCreateRequestFormFieldRules.json} (100%) rename examples/json/{TemplateCreateRequestDefaultExample.json => TemplateCreateRequestFormFieldsPerDocument.json} (100%) rename examples/json/{TemplateCreateResponseExample.json => TemplateCreateResponse.json} (100%) rename examples/json/{TemplateFilesResponseExample.json => TemplateFilesResponse.json} (100%) rename examples/json/{TemplateGetResponseExample.json => TemplateGetResponse.json} (100%) rename examples/json/{TemplateListResponseExample.json => TemplateListResponse.json} (100%) rename examples/json/{TemplateRemoveUserRequestDefaultExample.json => TemplateRemoveUserRequest.json} (100%) rename examples/json/{TemplateRemoveUserResponseExample.json => TemplateRemoveUserResponse.json} (100%) create mode 100644 examples/json/TemplateUpdateFilesRequest.json delete mode 100644 examples/json/TemplateUpdateFilesRequestDefaultExample.json rename examples/json/{TemplateUpdateFilesResponseExample.json => TemplateUpdateFilesResponse.json} (100%) rename examples/json/{UnclaimedDraftCreateEmbeddedRequestDefaultExample.json => UnclaimedDraftCreateEmbeddedRequest.json} (60%) rename examples/json/{UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json => UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json} (100%) rename examples/json/{UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json => UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json} (100%) rename examples/json/{UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json => UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json} (100%) rename examples/json/{UnclaimedDraftCreateEmbeddedResponseExample.json => UnclaimedDraftCreateEmbeddedResponse.json} (100%) rename examples/json/{UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json => UnclaimedDraftCreateEmbeddedWithTemplateRequest.json} (100%) rename examples/json/{UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json => UnclaimedDraftCreateEmbeddedWithTemplateResponse.json} (100%) rename examples/json/{UnclaimedDraftCreateRequestDefaultExample.json => UnclaimedDraftCreateRequest.json} (65%) rename examples/json/{UnclaimedDraftCreateRequestFormFieldGroupsExample.json => UnclaimedDraftCreateRequestFormFieldGroups.json} (100%) rename examples/json/{UnclaimedDraftCreateRequestFormFieldRulesExample.json => UnclaimedDraftCreateRequestFormFieldRules.json} (100%) rename examples/json/{UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json => UnclaimedDraftCreateRequestFormFieldsPerDocument.json} (100%) rename examples/json/{UnclaimedDraftCreateResponseExample.json => UnclaimedDraftCreateResponse.json} (100%) rename examples/json/{UnclaimedDraftEditAndResendExample.json => UnclaimedDraftEditAndResend.json} (100%) rename examples/json/{UnclaimedDraftEditAndResendRequestDefaultExample.json => UnclaimedDraftEditAndResendRequest.json} (100%) create mode 100644 sandbox/dotnet/Dropbox.SignSandbox.sln delete mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json delete mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore delete mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj delete mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs rename examples/FaxLineGet.cs => sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs (57%) create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs rename examples/FaxLineRemoveUser.cs => sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs (53%) create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs delete mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs rename examples/FaxLineList.cs => sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs (58%) create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs create mode 100644 sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs delete mode 100644 sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/dotnet/test_fixtures/pdf-sample.pdf delete mode 100644 sandbox/java-v1/pom.xml delete mode 100644 sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java delete mode 100644 sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json delete mode 100644 sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore delete mode 100644 sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java delete mode 100644 sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/java-v1/test_fixtures/pdf-sample.pdf delete mode 100644 sandbox/java-v2/pom.xml delete mode 100644 sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java delete mode 100644 sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json delete mode 100644 sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore delete mode 100644 sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java delete mode 100644 sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/java-v2/test_fixtures/pdf-sample.pdf create mode 100644 sandbox/java/.gitignore create mode 100644 sandbox/java/DropboxSignSandbox.iml create mode 100644 sandbox/java/build.gradle create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java create mode 100644 sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java create mode 100644 sandbox/node/.gitignore delete mode 100644 sandbox/node/Example.ts create mode 100644 sandbox/node/src/AccountCreateExample.ts create mode 100644 sandbox/node/src/AccountCreateOauthExample.ts create mode 100644 sandbox/node/src/AccountGetExample.ts create mode 100644 sandbox/node/src/AccountUpdateExample.ts create mode 100644 sandbox/node/src/AccountVerifyExample.ts create mode 100644 sandbox/node/src/ApiAppCreateExample.ts create mode 100644 sandbox/node/src/ApiAppDeleteExample.ts create mode 100644 sandbox/node/src/ApiAppGetExample.ts create mode 100644 sandbox/node/src/ApiAppListExample.ts create mode 100644 sandbox/node/src/ApiAppUpdateExample.ts create mode 100644 sandbox/node/src/BulkSendJobGetExample.ts create mode 100644 sandbox/node/src/BulkSendJobListExample.ts create mode 100644 sandbox/node/src/EmbeddedEditUrlExample.ts create mode 100644 sandbox/node/src/EmbeddedSignUrlExample.ts rename examples/EventCallback.ts => sandbox/node/src/EventCallbackExample.ts (100%) create mode 100644 sandbox/node/src/FaxDeleteExample.ts create mode 100644 sandbox/node/src/FaxFilesExample.ts create mode 100644 sandbox/node/src/FaxGetExample.ts create mode 100644 sandbox/node/src/FaxLineAddUserExample.ts create mode 100644 sandbox/node/src/FaxLineAreaCodeGetExample.ts create mode 100644 sandbox/node/src/FaxLineCreateExample.ts create mode 100644 sandbox/node/src/FaxLineDeleteExample.ts create mode 100644 sandbox/node/src/FaxLineGetExample.ts create mode 100644 sandbox/node/src/FaxLineListExample.ts create mode 100644 sandbox/node/src/FaxLineRemoveUserExample.ts create mode 100644 sandbox/node/src/FaxListExample.ts create mode 100644 sandbox/node/src/FaxSendExample.ts create mode 100644 sandbox/node/src/OauthTokenGenerateExample.ts create mode 100644 sandbox/node/src/OauthTokenRefreshExample.ts create mode 100644 sandbox/node/src/ReportCreateExample.ts create mode 100644 sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts create mode 100644 sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts create mode 100644 sandbox/node/src/SignatureRequestCancelExample.ts create mode 100644 sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts create mode 100644 sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts create mode 100644 sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts create mode 100644 sandbox/node/src/SignatureRequestEditEmbeddedExample.ts create mode 100644 sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts create mode 100644 sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts create mode 100644 sandbox/node/src/SignatureRequestEditExample.ts create mode 100644 sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts create mode 100644 sandbox/node/src/SignatureRequestEditWithTemplateExample.ts create mode 100644 sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts create mode 100644 sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts create mode 100644 sandbox/node/src/SignatureRequestFilesExample.ts create mode 100644 sandbox/node/src/SignatureRequestGetExample.ts create mode 100644 sandbox/node/src/SignatureRequestListExample.ts create mode 100644 sandbox/node/src/SignatureRequestReleaseHoldExample.ts create mode 100644 sandbox/node/src/SignatureRequestRemindExample.ts create mode 100644 sandbox/node/src/SignatureRequestRemoveExample.ts create mode 100644 sandbox/node/src/SignatureRequestSendExample.ts create mode 100644 sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts create mode 100644 sandbox/node/src/SignatureRequestSendWithTemplateExample.ts create mode 100644 sandbox/node/src/SignatureRequestUpdateExample.ts create mode 100644 sandbox/node/src/TeamAddMemberAccountIdExample.ts create mode 100644 sandbox/node/src/TeamAddMemberExample.ts create mode 100644 sandbox/node/src/TeamCreateExample.ts create mode 100644 sandbox/node/src/TeamDeleteExample.ts create mode 100644 sandbox/node/src/TeamGetExample.ts create mode 100644 sandbox/node/src/TeamInfoExample.ts create mode 100644 sandbox/node/src/TeamInvitesExample.ts create mode 100644 sandbox/node/src/TeamMembersExample.ts create mode 100644 sandbox/node/src/TeamRemoveMemberAccountIdExample.ts create mode 100644 sandbox/node/src/TeamRemoveMemberExample.ts create mode 100644 sandbox/node/src/TeamSubTeamsExample.ts create mode 100644 sandbox/node/src/TeamUpdateExample.ts create mode 100644 sandbox/node/src/TemplateAddUserExample.ts create mode 100644 sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts create mode 100644 sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts create mode 100644 sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts create mode 100644 sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts create mode 100644 sandbox/node/src/TemplateCreateExample.ts create mode 100644 sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts create mode 100644 sandbox/node/src/TemplateCreateFormFieldRulesExample.ts create mode 100644 sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts create mode 100644 sandbox/node/src/TemplateDeleteExample.ts create mode 100644 sandbox/node/src/TemplateFilesAsDataUriExample.ts create mode 100644 sandbox/node/src/TemplateFilesAsFileUrlExample.ts create mode 100644 sandbox/node/src/TemplateFilesExample.ts create mode 100644 sandbox/node/src/TemplateGetExample.ts create mode 100644 sandbox/node/src/TemplateListExample.ts create mode 100644 sandbox/node/src/TemplateRemoveUserExample.ts create mode 100644 sandbox/node/src/TemplateUpdateFilesExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts create mode 100644 sandbox/node/src/UnclaimedDraftEditAndResendExample.ts delete mode 100644 sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/node/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/node/test_fixtures/pdf-sample.pdf delete mode 100644 sandbox/node/tests/.config.dist.json delete mode 100644 sandbox/node/tests/.gitignore delete mode 100644 sandbox/node/tests/signatureRequest.test.ts create mode 100644 sandbox/node/tsconfig.json create mode 100644 sandbox/php/.gitignore delete mode 100644 sandbox/php/Example.php create mode 100644 sandbox/php/src/AccountCreateExample.php create mode 100644 sandbox/php/src/AccountCreateOauthExample.php create mode 100644 sandbox/php/src/AccountGetExample.php create mode 100644 sandbox/php/src/AccountUpdateExample.php create mode 100644 sandbox/php/src/AccountVerifyExample.php create mode 100644 sandbox/php/src/ApiAppCreateExample.php create mode 100644 sandbox/php/src/ApiAppDeleteExample.php create mode 100644 sandbox/php/src/ApiAppGetExample.php create mode 100644 sandbox/php/src/ApiAppListExample.php create mode 100644 sandbox/php/src/ApiAppUpdateExample.php create mode 100644 sandbox/php/src/BulkSendJobGetExample.php create mode 100644 sandbox/php/src/BulkSendJobListExample.php create mode 100644 sandbox/php/src/EmbeddedEditUrlExample.php create mode 100644 sandbox/php/src/EmbeddedSignUrlExample.php create mode 100644 sandbox/php/src/EventCallbackExample.php create mode 100644 sandbox/php/src/FaxDeleteExample.php create mode 100644 sandbox/php/src/FaxFilesExample.php create mode 100644 sandbox/php/src/FaxGetExample.php create mode 100644 sandbox/php/src/FaxLineAddUserExample.php create mode 100644 sandbox/php/src/FaxLineAreaCodeGetExample.php create mode 100644 sandbox/php/src/FaxLineCreateExample.php create mode 100644 sandbox/php/src/FaxLineDeleteExample.php create mode 100644 sandbox/php/src/FaxLineGetExample.php create mode 100644 sandbox/php/src/FaxLineListExample.php create mode 100644 sandbox/php/src/FaxLineRemoveUserExample.php create mode 100644 sandbox/php/src/FaxListExample.php create mode 100644 sandbox/php/src/FaxSendExample.php create mode 100644 sandbox/php/src/OauthTokenGenerateExample.php create mode 100644 sandbox/php/src/OauthTokenRefreshExample.php create mode 100644 sandbox/php/src/ReportCreateExample.php create mode 100644 sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php create mode 100644 sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php create mode 100644 sandbox/php/src/SignatureRequestCancelExample.php create mode 100644 sandbox/php/src/SignatureRequestCreateEmbeddedExample.php create mode 100644 sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php create mode 100644 sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php create mode 100644 sandbox/php/src/SignatureRequestEditEmbeddedExample.php create mode 100644 sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php create mode 100644 sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php create mode 100644 sandbox/php/src/SignatureRequestEditExample.php create mode 100644 sandbox/php/src/SignatureRequestEditGroupedSignersExample.php create mode 100644 sandbox/php/src/SignatureRequestEditWithTemplateExample.php create mode 100644 sandbox/php/src/SignatureRequestFilesAsDataUriExample.php create mode 100644 sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php create mode 100644 sandbox/php/src/SignatureRequestFilesExample.php create mode 100644 sandbox/php/src/SignatureRequestGetExample.php create mode 100644 sandbox/php/src/SignatureRequestListExample.php create mode 100644 sandbox/php/src/SignatureRequestReleaseHoldExample.php create mode 100644 sandbox/php/src/SignatureRequestRemindExample.php create mode 100644 sandbox/php/src/SignatureRequestRemoveExample.php create mode 100644 sandbox/php/src/SignatureRequestSendExample.php create mode 100644 sandbox/php/src/SignatureRequestSendGroupedSignersExample.php create mode 100644 sandbox/php/src/SignatureRequestSendWithTemplateExample.php create mode 100644 sandbox/php/src/SignatureRequestUpdateExample.php create mode 100644 sandbox/php/src/TeamAddMemberAccountIdExample.php create mode 100644 sandbox/php/src/TeamAddMemberExample.php create mode 100644 sandbox/php/src/TeamCreateExample.php create mode 100644 sandbox/php/src/TeamDeleteExample.php create mode 100644 sandbox/php/src/TeamGetExample.php create mode 100644 sandbox/php/src/TeamInfoExample.php create mode 100644 sandbox/php/src/TeamInvitesExample.php create mode 100644 sandbox/php/src/TeamMembersExample.php create mode 100644 sandbox/php/src/TeamRemoveMemberAccountIdExample.php create mode 100644 sandbox/php/src/TeamRemoveMemberExample.php create mode 100644 sandbox/php/src/TeamSubTeamsExample.php create mode 100644 sandbox/php/src/TeamUpdateExample.php create mode 100644 sandbox/php/src/TemplateAddUserExample.php create mode 100644 sandbox/php/src/TemplateCreateEmbeddedDraftExample.php create mode 100644 sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php create mode 100644 sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php create mode 100644 sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php create mode 100644 sandbox/php/src/TemplateCreateExample.php create mode 100644 sandbox/php/src/TemplateCreateFormFieldGroupsExample.php create mode 100644 sandbox/php/src/TemplateCreateFormFieldRulesExample.php create mode 100644 sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php create mode 100644 sandbox/php/src/TemplateDeleteExample.php create mode 100644 sandbox/php/src/TemplateFilesAsDataUriExample.php create mode 100644 sandbox/php/src/TemplateFilesAsFileUrlExample.php create mode 100644 sandbox/php/src/TemplateFilesExample.php create mode 100644 sandbox/php/src/TemplateGetExample.php create mode 100644 sandbox/php/src/TemplateListExample.php create mode 100644 sandbox/php/src/TemplateRemoveUserExample.php create mode 100644 sandbox/php/src/TemplateUpdateFilesExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php create mode 100644 sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php create mode 100644 sandbox/php/src/UnclaimedDraftEditAndResendExample.php delete mode 100644 sandbox/php/test/.config.dist.json delete mode 100644 sandbox/php/test/.gitignore delete mode 100644 sandbox/php/test/SignatureRequestTest.php delete mode 100644 sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/php/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/php/test_fixtures/pdf-sample.pdf create mode 100644 sandbox/python/.gitignore delete mode 100644 sandbox/python/Example.py create mode 100644 sandbox/python/src/AccountCreateExample.py create mode 100644 sandbox/python/src/AccountCreateOauthExample.py create mode 100644 sandbox/python/src/AccountGetExample.py create mode 100644 sandbox/python/src/AccountUpdateExample.py create mode 100644 sandbox/python/src/AccountVerifyExample.py create mode 100644 sandbox/python/src/ApiAppCreateExample.py create mode 100644 sandbox/python/src/ApiAppDeleteExample.py create mode 100644 sandbox/python/src/ApiAppGetExample.py create mode 100644 sandbox/python/src/ApiAppListExample.py create mode 100644 sandbox/python/src/ApiAppUpdateExample.py create mode 100644 sandbox/python/src/BulkSendJobGetExample.py create mode 100644 sandbox/python/src/BulkSendJobListExample.py create mode 100644 sandbox/python/src/EmbeddedEditUrlExample.py create mode 100644 sandbox/python/src/EmbeddedSignUrlExample.py create mode 100644 sandbox/python/src/EventCallbackExample.py create mode 100644 sandbox/python/src/FaxDeleteExample.py create mode 100644 sandbox/python/src/FaxFilesExample.py create mode 100644 sandbox/python/src/FaxGetExample.py rename examples/FaxLineAddUser.py => sandbox/python/src/FaxLineAddUserExample.py (50%) create mode 100644 sandbox/python/src/FaxLineAreaCodeGetExample.py create mode 100644 sandbox/python/src/FaxLineCreateExample.py create mode 100644 sandbox/python/src/FaxLineDeleteExample.py create mode 100644 sandbox/python/src/FaxLineGetExample.py create mode 100644 sandbox/python/src/FaxLineListExample.py create mode 100644 sandbox/python/src/FaxLineRemoveUserExample.py create mode 100644 sandbox/python/src/FaxListExample.py create mode 100644 sandbox/python/src/FaxSendExample.py create mode 100644 sandbox/python/src/OauthTokenGenerateExample.py create mode 100644 sandbox/python/src/OauthTokenRefreshExample.py create mode 100644 sandbox/python/src/ReportCreateExample.py create mode 100644 sandbox/python/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py create mode 100644 sandbox/python/src/SignatureRequestBulkSendWithTemplateExample.py create mode 100644 sandbox/python/src/SignatureRequestCancelExample.py create mode 100644 sandbox/python/src/SignatureRequestCreateEmbeddedExample.py create mode 100644 sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py create mode 100644 sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py create mode 100644 sandbox/python/src/SignatureRequestEditEmbeddedExample.py create mode 100644 sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py create mode 100644 sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py create mode 100644 sandbox/python/src/SignatureRequestEditExample.py create mode 100644 sandbox/python/src/SignatureRequestEditGroupedSignersExample.py create mode 100644 sandbox/python/src/SignatureRequestEditWithTemplateExample.py create mode 100644 sandbox/python/src/SignatureRequestFilesAsDataUriExample.py create mode 100644 sandbox/python/src/SignatureRequestFilesAsFileUrlExample.py create mode 100644 sandbox/python/src/SignatureRequestFilesExample.py create mode 100644 sandbox/python/src/SignatureRequestGetExample.py create mode 100644 sandbox/python/src/SignatureRequestListExample.py create mode 100644 sandbox/python/src/SignatureRequestReleaseHoldExample.py create mode 100644 sandbox/python/src/SignatureRequestRemindExample.py create mode 100644 sandbox/python/src/SignatureRequestRemoveExample.py rename examples/SignatureRequestSend.py => sandbox/python/src/SignatureRequestSendExample.py (54%) create mode 100644 sandbox/python/src/SignatureRequestSendGroupedSignersExample.py rename examples/SignatureRequestSendWithTemplate.py => sandbox/python/src/SignatureRequestSendWithTemplateExample.py (50%) create mode 100644 sandbox/python/src/SignatureRequestUpdateExample.py create mode 100644 sandbox/python/src/TeamAddMemberAccountIdExample.py create mode 100644 sandbox/python/src/TeamAddMemberExample.py create mode 100644 sandbox/python/src/TeamCreateExample.py create mode 100644 sandbox/python/src/TeamDeleteExample.py rename examples/TeamInfo.py => sandbox/python/src/TeamGetExample.py (54%) create mode 100644 sandbox/python/src/TeamInfoExample.py create mode 100644 sandbox/python/src/TeamInvitesExample.py create mode 100644 sandbox/python/src/TeamMembersExample.py create mode 100644 sandbox/python/src/TeamRemoveMemberAccountIdExample.py create mode 100644 sandbox/python/src/TeamRemoveMemberExample.py create mode 100644 sandbox/python/src/TeamSubTeamsExample.py create mode 100644 sandbox/python/src/TeamUpdateExample.py create mode 100644 sandbox/python/src/TemplateAddUserExample.py create mode 100644 sandbox/python/src/TemplateCreateEmbeddedDraftExample.py create mode 100644 sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py create mode 100644 sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.py create mode 100644 sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py create mode 100644 sandbox/python/src/TemplateCreateExample.py create mode 100644 sandbox/python/src/TemplateCreateFormFieldGroupsExample.py create mode 100644 sandbox/python/src/TemplateCreateFormFieldRulesExample.py create mode 100644 sandbox/python/src/TemplateCreateFormFieldsPerDocumentExample.py create mode 100644 sandbox/python/src/TemplateDeleteExample.py create mode 100644 sandbox/python/src/TemplateFilesAsDataUriExample.py create mode 100644 sandbox/python/src/TemplateFilesAsFileUrlExample.py create mode 100644 sandbox/python/src/TemplateFilesExample.py create mode 100644 sandbox/python/src/TemplateGetExample.py create mode 100644 sandbox/python/src/TemplateListExample.py create mode 100644 sandbox/python/src/TemplateRemoveUserExample.py create mode 100644 sandbox/python/src/TemplateUpdateFilesExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateEmbeddedExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateFormFieldGroupsExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateFormFieldRulesExample.py create mode 100644 sandbox/python/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.py create mode 100644 sandbox/python/src/UnclaimedDraftEditAndResendExample.py delete mode 100644 sandbox/python/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/python/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/python/test_fixtures/pdf-sample.pdf delete mode 100644 sandbox/python/tests/.config.dist.json delete mode 100644 sandbox/python/tests/.gitignore delete mode 100644 sandbox/python/tests/test_signature_request.py create mode 100644 sandbox/ruby/.gitignore delete mode 100644 sandbox/ruby/spec/.config.dist.json delete mode 100644 sandbox/ruby/spec/.gitignore delete mode 100644 sandbox/ruby/spec/signature_request_spec.rb delete mode 100644 sandbox/ruby/spec/spec_helper.rb create mode 100644 sandbox/ruby/src/AccountCreateExample.rb create mode 100644 sandbox/ruby/src/AccountCreateOauthExample.rb create mode 100644 sandbox/ruby/src/AccountGetExample.rb create mode 100644 sandbox/ruby/src/AccountUpdateExample.rb create mode 100644 sandbox/ruby/src/AccountVerifyExample.rb create mode 100644 sandbox/ruby/src/ApiAppCreateExample.rb create mode 100644 sandbox/ruby/src/ApiAppDeleteExample.rb create mode 100644 sandbox/ruby/src/ApiAppGetExample.rb create mode 100644 sandbox/ruby/src/ApiAppListExample.rb create mode 100644 sandbox/ruby/src/ApiAppUpdateExample.rb create mode 100644 sandbox/ruby/src/BulkSendJobGetExample.rb create mode 100644 sandbox/ruby/src/BulkSendJobListExample.rb create mode 100644 sandbox/ruby/src/EmbeddedEditUrlExample.rb create mode 100644 sandbox/ruby/src/EmbeddedSignUrlExample.rb create mode 100644 sandbox/ruby/src/EventCallbackExample.rb create mode 100644 sandbox/ruby/src/FaxDeleteExample.rb create mode 100644 sandbox/ruby/src/FaxFilesExample.rb create mode 100644 sandbox/ruby/src/FaxGetExample.rb create mode 100644 sandbox/ruby/src/FaxLineAddUserExample.rb create mode 100644 sandbox/ruby/src/FaxLineAreaCodeGetExample.rb create mode 100644 sandbox/ruby/src/FaxLineCreateExample.rb create mode 100644 sandbox/ruby/src/FaxLineDeleteExample.rb create mode 100644 sandbox/ruby/src/FaxLineGetExample.rb create mode 100644 sandbox/ruby/src/FaxLineListExample.rb create mode 100644 sandbox/ruby/src/FaxLineRemoveUserExample.rb create mode 100644 sandbox/ruby/src/FaxListExample.rb create mode 100644 sandbox/ruby/src/FaxSendExample.rb create mode 100644 sandbox/ruby/src/OauthTokenGenerateExample.rb create mode 100644 sandbox/ruby/src/OauthTokenRefreshExample.rb create mode 100644 sandbox/ruby/src/ReportCreateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestBulkSendWithTemplateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestCancelExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestEditExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestEditGroupedSignersExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestEditWithTemplateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestFilesAsDataUriExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestFilesAsFileUrlExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestFilesExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestGetExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestListExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestReleaseHoldExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestRemindExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestRemoveExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestSendExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestSendGroupedSignersExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb create mode 100644 sandbox/ruby/src/SignatureRequestUpdateExample.rb create mode 100644 sandbox/ruby/src/TeamAddMemberAccountIdExample.rb create mode 100644 sandbox/ruby/src/TeamAddMemberExample.rb create mode 100644 sandbox/ruby/src/TeamCreateExample.rb create mode 100644 sandbox/ruby/src/TeamDeleteExample.rb create mode 100644 sandbox/ruby/src/TeamGetExample.rb create mode 100644 sandbox/ruby/src/TeamInfoExample.rb create mode 100644 sandbox/ruby/src/TeamInvitesExample.rb create mode 100644 sandbox/ruby/src/TeamMembersExample.rb create mode 100644 sandbox/ruby/src/TeamRemoveMemberAccountIdExample.rb create mode 100644 sandbox/ruby/src/TeamRemoveMemberExample.rb create mode 100644 sandbox/ruby/src/TeamSubTeamsExample.rb create mode 100644 sandbox/ruby/src/TeamUpdateExample.rb create mode 100644 sandbox/ruby/src/TemplateAddUserExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateEmbeddedDraftExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateFormFieldGroupsExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateFormFieldRulesExample.rb create mode 100644 sandbox/ruby/src/TemplateCreateFormFieldsPerDocumentExample.rb create mode 100644 sandbox/ruby/src/TemplateDeleteExample.rb create mode 100644 sandbox/ruby/src/TemplateFilesAsDataUriExample.rb create mode 100644 sandbox/ruby/src/TemplateFilesAsFileUrlExample.rb create mode 100644 sandbox/ruby/src/TemplateFilesExample.rb create mode 100644 sandbox/ruby/src/TemplateGetExample.rb create mode 100644 sandbox/ruby/src/TemplateListExample.rb create mode 100644 sandbox/ruby/src/TemplateRemoveUserExample.rb create mode 100644 sandbox/ruby/src/TemplateUpdateFilesExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateEmbeddedExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateFormFieldGroupsExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateFormFieldRulesExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb create mode 100644 sandbox/ruby/src/UnclaimedDraftEditAndResendExample.rb delete mode 100644 sandbox/ruby/test_fixtures/SignatureRequestCreateEmbeddedRequest.json delete mode 100644 sandbox/ruby/test_fixtures/SignatureRequestSendRequest.json delete mode 100644 sandbox/ruby/test_fixtures/pdf-sample.pdf create mode 100644 sdks/dotnet/templates/Entry.cs create mode 100644 sdks/java-v2/templates/Main.java diff --git a/bin/sandbox-dotnet b/bin/sandbox-dotnet index 6ccea44b3..c74759887 100755 --- a/bin/sandbox-dotnet +++ b/bin/sandbox-dotnet @@ -10,8 +10,9 @@ TARGET_DIR="${DIR}/../sandbox/dotnet" ARTIFACTS_DIR="${DIR}/../sandbox/dotnet/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.nupkg" +rm -f "${TARGET_DIR}/src/Dropbox.SignSandbox/*.cs" +cp "${SDK_DIR}/templates/Entry.cs" "${TARGET_DIR}/src/Dropbox.SignSandbox/Entry.cs" docker run --rm -it \ -v "${SDK_DIR}:${WORKING_DIR}" \ @@ -19,10 +20,10 @@ docker run --rm -it \ -v "${TARGET_DIR}:/target" \ -w "${WORKING_DIR}" \ -u root:root \ - mcr.microsoft.com/dotnet/sdk:6.0 dotnet pack -o /artifacts + mcr.microsoft.com/dotnet/sdk:9.0 dotnet pack -o /artifacts docker run --rm -it \ -v "${TARGET_DIR}:${WORKING_DIR}" \ -w "${WORKING_DIR}" \ -u root:root \ - mcr.microsoft.com/dotnet/sdk:6.0 dotnet build + mcr.microsoft.com/dotnet/sdk:9.0 dotnet build diff --git a/bin/sandbox-java-v2 b/bin/sandbox-java similarity index 64% rename from bin/sandbox-java-v2 rename to bin/sandbox-java index 9349f5d0c..6f86eb5ac 100755 --- a/bin/sandbox-java-v2 +++ b/bin/sandbox-java @@ -6,12 +6,13 @@ DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/openapi" SDK_DIR="${DIR}/../sdks/java-v2" -TARGET_DIR="${DIR}/../sandbox/java-v2" -ARTIFACTS_DIR="${DIR}/../sandbox/java-v2/artifacts" +TARGET_DIR="${DIR}/../sandbox/java" +ARTIFACTS_DIR="${DIR}/../sandbox/java/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.jar" +rm -f "${TARGET_DIR}/src/main/java/com/dropbox/sign_sandbox/*.java" +cp "${SDK_DIR}/templates/Main.java" "${TARGET_DIR}/src/main/java/com/dropbox/sign_sandbox/Main.java" docker run --rm -it \ -v "${SDK_DIR}:${WORKING_DIR}" \ diff --git a/bin/sandbox-java-v1 b/bin/sandbox-java-v1 deleted file mode 100755 index 15bd9ad06..000000000 --- a/bin/sandbox-java-v1 +++ /dev/null @@ -1,25 +0,0 @@ -#!/usr/bin/env bash - -set -e - -DIR=$(cd `dirname $0` && pwd) - -WORKING_DIR="/app/openapi" -SDK_DIR="${DIR}/../sdks/java-v1" -TARGET_DIR="${DIR}/../sandbox/java-v1" -ARTIFACTS_DIR="${DIR}/../sandbox/java-v1/artifacts" - -mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* - -docker run --rm -it \ - -v "${SDK_DIR}:${WORKING_DIR}" \ - -v "${ARTIFACTS_DIR}:/artifacts" \ - -v "dropbox-sign-sdk-gradle-cache:/home/gradle/.gradle" \ - -v "dropbox-sign-sdk-maven-cache:/root/.m2" \ - -w "${WORKING_DIR}" \ - -e GEN_DIR=/app \ - gradle:7.6.1-jdk11 ./gradlew clean fatJar - -cp "${SDK_DIR}/build/libs/"dropbox-sign-*-all.jar "${ARTIFACTS_DIR}/dropbox-sign.jar" diff --git a/bin/sandbox-node b/bin/sandbox-node index d8d68d366..60da86c08 100755 --- a/bin/sandbox-node +++ b/bin/sandbox-node @@ -10,8 +10,9 @@ TARGET_DIR="${DIR}/../sandbox/node" ARTIFACTS_DIR="${DIR}/../sandbox/node/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.tgz" +rm -f "${TARGET_DIR}/src/*.ts" +rm -f "${TARGET_DIR}/src/*.js" rm -f "${TARGET_DIR}/package-lock.json" rm -rf "${TARGET_DIR}/node_modules" @@ -20,15 +21,20 @@ docker run -it --rm \ -v "${ARTIFACTS_DIR}:/artifacts" \ -v "dropbox-sign-sdk-npm-cache:/root/.npm" \ -w "${WORKING_DIR}" \ - node:17 npm pack --pack-destination /artifacts + node:22 npm install -mv "${ARTIFACTS_DIR}/"*.tgz "${ARTIFACTS_DIR}/dropbox-sign-sdk.tgz" +docker run -it --rm \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-npm-cache:/root/.npm" \ + -w "${WORKING_DIR}" \ + node:22 npm run build docker run -it --rm \ - -v "${TARGET_DIR}:${WORKING_DIR}" \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ -v "dropbox-sign-sdk-npm-cache:/root/.npm" \ -w "${WORKING_DIR}" \ - node:17 npm install + node:22 npm pack --pack-destination /artifacts -printf "\nDONE! Run with:\n\n" -printf "\tnpx ts-node Example.ts" +mv "${ARTIFACTS_DIR}/"*.tgz "${ARTIFACTS_DIR}/dropbox-sign-sdk.tgz" diff --git a/bin/sandbox-php b/bin/sandbox-php index 1479a674f..261f767b9 100755 --- a/bin/sandbox-php +++ b/bin/sandbox-php @@ -10,10 +10,9 @@ TARGET_DIR="${DIR}/../sandbox/php" ARTIFACTS_DIR="${DIR}/../sandbox/php/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -rf "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.zip" rm -f "${TARGET_DIR}/composer.lock" -rm -rf "${TARGET_DIR}/vendor/hellosign" +rm -rf "${TARGET_DIR}/vendor" cp -r "${SDK_DIR}" "${ARTIFACTS_DIR}/package" cd "${ARTIFACTS_DIR}/package" @@ -41,13 +40,6 @@ zip -9 -r "${ARTIFACTS_DIR}/dropbox-sign.zip" \ "./test/*" \ "./vendor/*" -docker run -it --rm \ - -v "${TARGET_DIR}:${WORKING_DIR}" \ - -v "dropbox-sign-sdk-composer-cache:/.composer" \ - -w "${WORKING_DIR}" \ - -u root:root \ - jtreminio/php-cli:7.4 composer install - cd "${ARTIFACTS_DIR}" rm -rf "${ARTIFACTS_DIR}/package" diff --git a/bin/sandbox-ruby b/bin/sandbox-ruby new file mode 100755 index 000000000..8abb45aa6 --- /dev/null +++ b/bin/sandbox-ruby @@ -0,0 +1,32 @@ +#!/usr/bin/env bash + +set -e + +DIR=$(cd `dirname $0` && pwd) + +WORKING_DIR="/app/openapi" +SDK_DIR="${DIR}/../sdks/ruby" +TARGET_DIR="${DIR}/../sandbox/ruby" +ARTIFACTS_DIR="${DIR}/../sandbox/ruby/artifacts" + +rm -rf "${ARTIFACTS_DIR}" +mkdir -p "${ARTIFACTS_DIR}/gems" + +docker run --rm \ + -e GEM_HOME="/.gem-cache" \ + -e BUNDLE_PATH="/.bundle-cache" \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-gem-cache:/.gem-cache" \ + -v "dropbox-sign-sdk-bundle-cache:/.bundle-cache" \ + -w "${WORKING_DIR}" \ + ruby:3.4 gem build dropbox-sign.gemspec -o /artifacts/gems/dropbox-sign.gem + +docker run --rm \ + -e GEM_HOME="/.gem-cache" \ + -e BUNDLE_PATH="/.bundle-cache" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-gem-cache:/.gem-cache" \ + -v "dropbox-sign-sdk-bundle-cache:/.bundle-cache" \ + -w "/artifacts" \ + ruby:3.4 gem generate_index diff --git a/build b/build index 2ef773ff6..f706758a2 100755 --- a/build +++ b/build @@ -14,4 +14,11 @@ printf "\n" bash "${DIR}/bin/php" ./bin/generate-oas.php +cp "${DIR}/examples/"*.cs "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox/" +cp "${DIR}/examples/"*.java "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox/" +cp "${DIR}/examples/"*.php "${DIR}/sandbox/php/src/" +cp "${DIR}/examples/"*.py "${DIR}/sandbox/python/src/" +cp "${DIR}/examples/"*.rb "${DIR}/sandbox/ruby/src/" +cp "${DIR}/examples/"*.ts "${DIR}/sandbox/node/src/" + printf "Success!\n" diff --git a/examples/AccountCreate.cs b/examples/AccountCreate.cs deleted file mode 100644 index 360f7751f..000000000 --- a/examples/AccountCreate.cs +++ /dev/null @@ -1,36 +0,0 @@ -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountCreateRequest( - emailAddress: "newuser@dropboxsign.com" - ); - - try - { - var result = accountApi.AccountCreate(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/examples/AccountCreate.java b/examples/AccountCreate.java deleted file mode 100644 index 6063411c0..000000000 --- a/examples/AccountCreate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountCreate.js b/examples/AccountCreate.js deleted file mode 100644 index 3aed64809..000000000 --- a/examples/AccountCreate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountCreate.php b/examples/AccountCreate.php deleted file mode 100644 index 73176d1e2..000000000 --- a/examples/AccountCreate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); - -try { - $result = $accountApi->accountCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountCreate.rb b/examples/AccountCreate.rb deleted file mode 100644 index b572ae10c..000000000 --- a/examples/AccountCreate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" - -begin - result = account_api.account_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountCreate.ts b/examples/AccountCreate.ts deleted file mode 100644 index 2819e3db8..000000000 --- a/examples/AccountCreate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountCreateRequest = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountCreateExample.cs b/examples/AccountCreateExample.cs new file mode 100644 index 000000000..373d6a20f --- /dev/null +++ b/examples/AccountCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountCreateExample.java b/examples/AccountCreateExample.java new file mode 100644 index 000000000..a9b8c52d2 --- /dev/null +++ b/examples/AccountCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountCreateExample.php b/examples/AccountCreateExample.php new file mode 100644 index 000000000..736fb3cc6 --- /dev/null +++ b/examples/AccountCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/examples/AccountCreate.py b/examples/AccountCreateExample.py similarity index 52% rename from examples/AccountCreate.py rename to examples/AccountCreateExample.py index 6bdaebb21..f911a898b 100644 --- a/examples/AccountCreate.py +++ b/examples/AccountCreateExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( + account_create_request = models.AccountCreateRequest( email_address="newuser@dropboxsign.com", ) try: - response = account_api.account_create(data) + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_create: %s\n" % e) diff --git a/examples/AccountCreateExample.rb b/examples/AccountCreateExample.rb new file mode 100644 index 000000000..6ce6db264 --- /dev/null +++ b/examples/AccountCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" + +begin + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_create: #{e}" +end diff --git a/examples/AccountCreate.sh b/examples/AccountCreateExample.sh similarity index 100% rename from examples/AccountCreate.sh rename to examples/AccountCreateExample.sh diff --git a/examples/AccountCreateExample.ts b/examples/AccountCreateExample.ts new file mode 100644 index 000000000..f5b490085 --- /dev/null +++ b/examples/AccountCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/examples/AccountCreateOauthExample.cs b/examples/AccountCreateOauthExample.cs new file mode 100644 index 000000000..1976cb18e --- /dev/null +++ b/examples/AccountCreateOauthExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateOauthExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com", + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountCreateOauthExample.java b/examples/AccountCreateOauthExample.java new file mode 100644 index 000000000..5cfc13531 --- /dev/null +++ b/examples/AccountCreateOauthExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateOauthExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + accountCreateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + accountCreateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountCreateOauthExample.php b/examples/AccountCreateOauthExample.php new file mode 100644 index 000000000..0c4898be2 --- /dev/null +++ b/examples/AccountCreateOauthExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com") + ->setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/examples/AccountCreateOauthExample.py b/examples/AccountCreateOauthExample.py new file mode 100644 index 000000000..8930f04d6 --- /dev/null +++ b/examples/AccountCreateOauthExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + account_create_request = models.AccountCreateRequest( + email_address="newuser@dropboxsign.com", + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + ) + + try: + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_create: %s\n" % e) diff --git a/examples/AccountCreateOauthExample.rb b/examples/AccountCreateOauthExample.rb new file mode 100644 index 000000000..26ebdc768 --- /dev/null +++ b/examples/AccountCreateOauthExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" +account_create_request.client_id = "cc91c61d00f8bb2ece1428035716b" +account_create_request.client_secret = "1d14434088507ffa390e6f5528465" + +begin + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_create: #{e}" +end diff --git a/examples/AccountCreateOauthExample.ts b/examples/AccountCreateOauthExample.ts new file mode 100644 index 000000000..0554d4d79 --- /dev/null +++ b/examples/AccountCreateOauthExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; +accountCreateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +accountCreateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/examples/AccountGet.cs b/examples/AccountGet.cs deleted file mode 100644 index e6e35af25..000000000 --- a/examples/AccountGet.cs +++ /dev/null @@ -1,32 +0,0 @@ -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - try - { - var result = accountApi.AccountGet(null, "jack@example.com"); - 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/AccountGet.java b/examples/AccountGet.java deleted file mode 100644 index e05f3ff12..000000000 --- a/examples/AccountGet.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - try { - AccountGetResponse result = accountApi.accountGet(null, "jack@example.com"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountGet.js b/examples/AccountGet.js deleted file mode 100644 index 00d03af5c..000000000 --- a/examples/AccountGet.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = accountApi.accountGet(undefined, "jack@example.com"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountGet.php b/examples/AccountGet.php deleted file mode 100644 index 25ac7fb65..000000000 --- a/examples/AccountGet.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -try { - $result = $accountApi->accountGet(null, 'jack@example.com'); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountGet.rb b/examples/AccountGet.rb deleted file mode 100644 index 426fcb67e..000000000 --- a/examples/AccountGet.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -begin - result = account_api.account_get({ email_address: "jack@example.com" }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountGet.ts b/examples/AccountGet.ts deleted file mode 100644 index 00d03af5c..000000000 --- a/examples/AccountGet.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = accountApi.accountGet(undefined, "jack@example.com"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountGetExample.cs b/examples/AccountGetExample.cs new file mode 100644 index 000000000..83d94716e --- /dev/null +++ b/examples/AccountGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new AccountApi(config).AccountGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountGetExample.java b/examples/AccountGetExample.java new file mode 100644 index 000000000..3a90b0375 --- /dev/null +++ b/examples/AccountGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountGetExample.php b/examples/AccountGetExample.php new file mode 100644 index 000000000..96b594d7e --- /dev/null +++ b/examples/AccountGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}"; +} diff --git a/examples/FaxLineAreaCodeGet.py b/examples/AccountGetExample.py similarity index 52% rename from examples/FaxLineAreaCodeGet.py rename to examples/AccountGetExample.py index f001c0267..d7e910dd6 100644 --- a/examples/FaxLineAreaCodeGet.py +++ b/examples/AccountGetExample.py @@ -1,17 +1,18 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_area_code_get("US", "CA") + response = api.AccountApi(api_client).account_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_get: %s\n" % e) diff --git a/examples/AccountGetExample.rb b/examples/AccountGetExample.rb new file mode 100644 index 000000000..3b8fb5d9e --- /dev/null +++ b/examples/AccountGetExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::AccountApi.new.account_get + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_get: #{e}" +end diff --git a/examples/AccountGet.sh b/examples/AccountGetExample.sh similarity index 100% rename from examples/AccountGet.sh rename to examples/AccountGetExample.sh diff --git a/examples/AccountGetExample.ts b/examples/AccountGetExample.ts new file mode 100644 index 000000000..6bc7ae2de --- /dev/null +++ b/examples/AccountGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.accountGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountGet:"); + console.log(error.body); +}); diff --git a/examples/AccountUpdate.cs b/examples/AccountUpdate.cs deleted file mode 100644 index 2261b47f2..000000000 --- a/examples/AccountUpdate.cs +++ /dev/null @@ -1,36 +0,0 @@ -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountUpdateRequest( - callbackUrl: "https://www.example.com/callback" - ); - - try - { - var result = accountApi.AccountUpdate(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/examples/AccountUpdate.java b/examples/AccountUpdate.java deleted file mode 100644 index 9b8d374c1..000000000 --- a/examples/AccountUpdate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountUpdateRequest() - .callbackUrl("https://www.example.com/callback"); - - try { - AccountGetResponse result = accountApi.accountUpdate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountUpdate.js b/examples/AccountUpdate.js deleted file mode 100644 index 0d48a5917..000000000 --- a/examples/AccountUpdate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - callbackUrl: "https://www.example.com/callback", -}; - -const result = accountApi.accountUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountUpdate.php b/examples/AccountUpdate.php deleted file mode 100644 index b94dae236..000000000 --- a/examples/AccountUpdate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountUpdateRequest(); -$data->setCallbackUrl("https://www.example.com/callback"); - -try { - $result = $accountApi->accountUpdate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountUpdate.rb b/examples/AccountUpdate.rb deleted file mode 100644 index 55b127bcb..000000000 --- a/examples/AccountUpdate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountUpdateRequest.new -data.callback_url = "https://www.example.com/callback" - -begin - result = account_api.account_update(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountUpdate.ts b/examples/AccountUpdate.ts deleted file mode 100644 index c76ac1d21..000000000 --- a/examples/AccountUpdate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountUpdateRequest = { - callbackUrl: "https://www.example.com/callback", -}; - -const result = accountApi.accountUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountUpdateExample.cs b/examples/AccountUpdateExample.cs new file mode 100644 index 000000000..f62bb1125 --- /dev/null +++ b/examples/AccountUpdateExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountUpdateRequest = new AccountUpdateRequest( + callbackUrl: "https://www.example.com/callback", + locale: "en-US" + ); + + try + { + var response = new AccountApi(config).AccountUpdate( + accountUpdateRequest: accountUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountUpdateExample.java b/examples/AccountUpdateExample.java new file mode 100644 index 000000000..ac9c0d227 --- /dev/null +++ b/examples/AccountUpdateExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountUpdateExample.php b/examples/AccountUpdateExample.php new file mode 100644 index 000000000..64a1ad38d --- /dev/null +++ b/examples/AccountUpdateExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest()) + ->setCallbackUrl("https://www.example.com/callback") + ->setLocale("en-US"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate( + account_update_request: $account_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}"; +} diff --git a/examples/AccountUpdate.py b/examples/AccountUpdateExample.py similarity index 51% rename from examples/AccountUpdate.py rename to examples/AccountUpdateExample.py index d1cf4a496..5ef5466ea 100644 --- a/examples/AccountUpdate.py +++ b/examples/AccountUpdateExample.py @@ -1,23 +1,25 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountUpdateRequest( + account_update_request = models.AccountUpdateRequest( callback_url="https://www.example.com/callback", + locale="en-US", ) try: - response = account_api.account_update(data) + response = api.AccountApi(api_client).account_update( + account_update_request=account_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_update: %s\n" % e) diff --git a/examples/AccountUpdateExample.rb b/examples/AccountUpdateExample.rb new file mode 100644 index 000000000..f8d7f1b2d --- /dev/null +++ b/examples/AccountUpdateExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_update_request = Dropbox::Sign::AccountUpdateRequest.new +account_update_request.callback_url = "https://www.example.com/callback" +account_update_request.locale = "en-US" + +begin + response = Dropbox::Sign::AccountApi.new.account_update( + account_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_update: #{e}" +end diff --git a/examples/AccountUpdate.sh b/examples/AccountUpdateExample.sh similarity index 100% rename from examples/AccountUpdate.sh rename to examples/AccountUpdateExample.sh diff --git a/examples/AccountUpdateExample.ts b/examples/AccountUpdateExample.ts new file mode 100644 index 000000000..8a546ee0e --- /dev/null +++ b/examples/AccountUpdateExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountUpdateRequest = new models.AccountUpdateRequest(); +accountUpdateRequest.callbackUrl = "https://www.example.com/callback"; +accountUpdateRequest.locale = "en-US"; + +apiCaller.accountUpdate( + accountUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountUpdate:"); + console.log(error.body); +}); diff --git a/examples/AccountVerify.cs b/examples/AccountVerify.cs deleted file mode 100644 index 36aacd066..000000000 --- a/examples/AccountVerify.cs +++ /dev/null @@ -1,36 +0,0 @@ -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountVerifyRequest( - emailAddress: "some_user@dropboxsign.com" - ); - - try - { - var result = accountApi.AccountVerify(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/examples/AccountVerify.java b/examples/AccountVerify.java deleted file mode 100644 index 36a96660d..000000000 --- a/examples/AccountVerify.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountVerifyRequest() - .emailAddress("some_user@dropboxsign.com"); - - try { - AccountVerifyResponse result = accountApi.accountVerify(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountVerify.js b/examples/AccountVerify.js deleted file mode 100644 index 689286eed..000000000 --- a/examples/AccountVerify.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "some_user@dropboxsign.com", -}; - -const result = accountApi.accountVerify(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountVerify.php b/examples/AccountVerify.php deleted file mode 100644 index 12a037173..000000000 --- a/examples/AccountVerify.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountVerifyRequest(); -$data->setEmailAddress("some_user@dropboxsign.com"); - -try { - $result = $accountApi->accountVerify($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountVerify.rb b/examples/AccountVerify.rb deleted file mode 100644 index 20295f3d2..000000000 --- a/examples/AccountVerify.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountVerifyRequest.new -data.email_address = "some_user@dropboxsign.com" - -begin - result = account_api.account_verify(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountVerify.ts b/examples/AccountVerify.ts deleted file mode 100644 index d2a75488b..000000000 --- a/examples/AccountVerify.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountVerifyRequest = { - emailAddress: "some_user@dropboxsign.com", -}; - -const result = accountApi.accountVerify(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountVerifyExample.cs b/examples/AccountVerifyExample.cs new file mode 100644 index 000000000..cba51330d --- /dev/null +++ b/examples/AccountVerifyExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountVerifyExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountVerifyRequest = new AccountVerifyRequest( + emailAddress: "some_user@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountVerify( + accountVerifyRequest: accountVerifyRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountVerify: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountVerifyExample.java b/examples/AccountVerifyExample.java new file mode 100644 index 000000000..6d6f22f72 --- /dev/null +++ b/examples/AccountVerifyExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountVerifyExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountVerify"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountVerifyExample.php b/examples/AccountVerifyExample.php new file mode 100644 index 000000000..acdee34e7 --- /dev/null +++ b/examples/AccountVerifyExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest()) + ->setEmailAddress("some_user@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify( + account_verify_request: $account_verify_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}"; +} diff --git a/examples/AccountVerify.py b/examples/AccountVerifyExample.py similarity index 52% rename from examples/AccountVerify.py rename to examples/AccountVerifyExample.py index 0e95fa2e4..65bdb8018 100644 --- a/examples/AccountVerify.py +++ b/examples/AccountVerifyExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountVerifyRequest( + account_verify_request = models.AccountVerifyRequest( email_address="some_user@dropboxsign.com", ) try: - response = account_api.account_verify(data) + response = api.AccountApi(api_client).account_verify( + account_verify_request=account_verify_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_verify: %s\n" % e) diff --git a/examples/AccountVerifyExample.rb b/examples/AccountVerifyExample.rb new file mode 100644 index 000000000..8e57affce --- /dev/null +++ b/examples/AccountVerifyExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_verify_request = Dropbox::Sign::AccountVerifyRequest.new +account_verify_request.email_address = "some_user@dropboxsign.com" + +begin + response = Dropbox::Sign::AccountApi.new.account_verify( + account_verify_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_verify: #{e}" +end diff --git a/examples/AccountVerify.sh b/examples/AccountVerifyExample.sh similarity index 100% rename from examples/AccountVerify.sh rename to examples/AccountVerifyExample.sh diff --git a/examples/AccountVerifyExample.ts b/examples/AccountVerifyExample.ts new file mode 100644 index 000000000..417ffce6d --- /dev/null +++ b/examples/AccountVerifyExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountVerifyRequest = new models.AccountVerifyRequest(); +accountVerifyRequest.emailAddress = "some_user@dropboxsign.com"; + +apiCaller.accountVerify( + accountVerifyRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountVerify:"); + console.log(error.body); +}); diff --git a/examples/ApiAppCreate.cs b/examples/ApiAppCreate.cs deleted file mode 100644 index bc78c6428..000000000 --- a/examples/ApiAppCreate.cs +++ /dev/null @@ -1,59 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var oauth = new SubOAuth( - callbackUrl: "https://example.com/oauth", - scopes: new List() { - SubOAuth.ScopesEnum.BasicAccountInfo, - SubOAuth.ScopesEnum.RequestSignature - } - ); - - var whiteLabelingOptions = new SubWhiteLabelingOptions( - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff" - ); - - var customLogoFile = new FileStream( - "CustomLogoFile.png", - FileMode.Open - ); - - var data = new ApiAppCreateRequest( - name: "My Production App", - domains: new List(){"example.com"}, - oauth: oauth, - whiteLabelingOptions: whiteLabelingOptions, - customLogoFile: customLogoFile - ); - - try - { - var result = apiAppApi.ApiAppCreate(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/examples/ApiAppCreate.java b/examples/ApiAppCreate.java deleted file mode 100644 index 2d3c80fcf..000000000 --- a/examples/ApiAppCreate.java +++ /dev/null @@ -1,51 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of((SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppCreateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - try { - ApiAppGetResponse result = apiAppApi.apiAppCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppCreate.js b/examples/ApiAppCreate.js deleted file mode 100644 index 09d14e50a..000000000 --- a/examples/ApiAppCreate.js +++ /dev/null @@ -1,39 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const oauth = { - callbackUrl: "https://example.com/oauth", - scopes: [ - "basic_account_info", - "request_signature", - ], -}; - -const whiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data = { - name: "My Production App", - domains: ["example.com"], - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - oauth, - whiteLabelingOptions, -}; - -const result = apiAppApi.apiAppCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppCreate.php b/examples/ApiAppCreate.php deleted file mode 100644 index 8686c98fb..000000000 --- a/examples/ApiAppCreate.php +++ /dev/null @@ -1,42 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$oauth = new Dropbox\Sign\Model\SubOAuth(); -$oauth->setCallbackUrl("https://example.com/oauth") - ->setScopes([ - Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, - Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, - ]); - -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") - ->setPrimaryButtonTextColor("#ffffff"); - -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppCreateRequest(); -$data->setName("My Production App") - ->setDomains(["example.com"]) - ->setOauth($oauth) - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -try { - $result = $apiAppApi->apiAppCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppCreate.rb b/examples/ApiAppCreate.rb deleted file mode 100644 index 6b1ca23bf..000000000 --- a/examples/ApiAppCreate.rb +++ /dev/null @@ -1,35 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -oauth = Dropbox::Sign::SubOAuth.new -oauth.callback_url = "https://example.com/oauth" -oauth.scopes = %w[basic_account_info request_signature] - -white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new -white_labeling_options.primary_button_color = "#00b3e6" -white_labeling_options.primary_button_text_color = "#ffffff" - -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppCreateRequest.new -data.name = "My Production App" -data.domains = ["example.com"] -data.oauth = oauth -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -begin - result = api_app_api.api_app_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppCreate.ts b/examples/ApiAppCreate.ts deleted file mode 100644 index bcbec4d99..000000000 --- a/examples/ApiAppCreate.ts +++ /dev/null @@ -1,39 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const oauth: DropboxSign.SubOAuth = { - callbackUrl: "https://example.com/oauth", - scopes: [ - DropboxSign.SubOAuth.ScopesEnum.BasicAccountInfo, - DropboxSign.SubOAuth.ScopesEnum.RequestSignature, - ], -}; - -const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data: DropboxSign.ApiAppCreateRequest = { - name: "My Production App", - domains: ["example.com"], - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - oauth, - whiteLabelingOptions, -}; - -const result = apiAppApi.apiAppCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppCreateExample.cs b/examples/ApiAppCreateExample.cs new file mode 100644 index 000000000..277e40121 --- /dev/null +++ b/examples/ApiAppCreateExample.cs @@ -0,0 +1,61 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppCreateRequest = new ApiAppCreateRequest( + name: "My Production App", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppCreate( + apiAppCreateRequest: apiAppCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppCreateExample.java b/examples/ApiAppCreateExample.java new file mode 100644 index 000000000..9422376ae --- /dev/null +++ b/examples/ApiAppCreateExample.java @@ -0,0 +1,60 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppCreateExample.php b/examples/ApiAppCreateExample.php new file mode 100644 index 000000000..7ec68a6f5 --- /dev/null +++ b/examples/ApiAppCreateExample.php @@ -0,0 +1,42 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_create_request = (new Dropbox\Sign\Model\ApiAppCreateRequest()) + ->setName("My Production App") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppCreate( + api_app_create_request: $api_app_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppCreate: {$e->getMessage()}"; +} diff --git a/examples/ApiAppCreate.py b/examples/ApiAppCreateExample.py similarity index 55% rename from examples/ApiAppCreate.py rename to examples/ApiAppCreateExample.py index 634057b35..345edd053 100644 --- a/examples/ApiAppCreate.py +++ b/examples/ApiAppCreateExample.py @@ -1,20 +1,21 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - oauth = models.SubOAuth( callback_url="https://example.com/oauth", - scopes=["basic_account_info" "request_signature"], + scopes=[ + "basic_account_info", + "request_signature", + ], ) white_labeling_options = models.SubWhiteLabelingOptions( @@ -22,18 +23,21 @@ primary_button_text_color="#ffffff", ) - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppCreateRequest( + api_app_create_request = models.ApiAppCreateRequest( name="My Production App", - domains=["example.com"], + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), oauth=oauth, white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, ) try: - response = api_app_api.api_app_create(data) + response = api.ApiAppApi(api_client).api_app_create( + api_app_create_request=api_app_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_create: %s\n" % e) diff --git a/examples/ApiAppCreateExample.rb b/examples/ApiAppCreateExample.rb new file mode 100644 index 000000000..d2b959780 --- /dev/null +++ b/examples/ApiAppCreateExample.rb @@ -0,0 +1,37 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] + +white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new +white_labeling_options.primary_button_color = "#00b3e6" +white_labeling_options.primary_button_text_color = "#ffffff" + +api_app_create_request = Dropbox::Sign::ApiAppCreateRequest.new +api_app_create_request.name = "My Production App" +api_app_create_request.domains = [ + "example.com", +] +api_app_create_request.custom_logo_file = File.new("CustomLogoFile.png", "r") +api_app_create_request.oauth = oauth +api_app_create_request.white_labeling_options = white_labeling_options + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_create( + api_app_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_create: #{e}" +end diff --git a/examples/ApiAppCreate.sh b/examples/ApiAppCreateExample.sh similarity index 100% rename from examples/ApiAppCreate.sh rename to examples/ApiAppCreateExample.sh diff --git a/examples/ApiAppCreateExample.ts b/examples/ApiAppCreateExample.ts new file mode 100644 index 000000000..be9234816 --- /dev/null +++ b/examples/ApiAppCreateExample.ts @@ -0,0 +1,36 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppCreateRequest = new models.ApiAppCreateRequest(); +apiAppCreateRequest.name = "My Production App"; +apiAppCreateRequest.domains = [ + "example.com", +]; +apiAppCreateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppCreateRequest.oauth = oauth; +apiAppCreateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppCreate( + apiAppCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppCreate:"); + console.log(error.body); +}); diff --git a/examples/ApiAppDelete.cs b/examples/ApiAppDelete.cs deleted file mode 100644 index 540adfe0d..000000000 --- a/examples/ApiAppDelete.cs +++ /dev/null @@ -1,34 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try - { - apiAppApi.ApiAppDelete(clientId); - } - 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/ApiAppDelete.java b/examples/ApiAppDelete.java deleted file mode 100644 index fe443187e..000000000 --- a/examples/ApiAppDelete.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - apiAppApi.apiAppDelete(clientId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppDelete.js b/examples/ApiAppDelete.js deleted file mode 100644 index 37f7b0e26..000000000 --- a/examples/ApiAppDelete.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppDelete(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppDelete.php b/examples/ApiAppDelete.php deleted file mode 100644 index d53477ba4..000000000 --- a/examples/ApiAppDelete.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $apiAppApi->apiAppDelete($clientId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppDelete.py b/examples/ApiAppDelete.py deleted file mode 100644 index 3733306cf..000000000 --- a/examples/ApiAppDelete.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - api_app_api.api_app_delete(client_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppDelete.rb b/examples/ApiAppDelete.rb deleted file mode 100644 index 6e69462bb..000000000 --- a/examples/ApiAppDelete.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_delete(client_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppDelete.ts b/examples/ApiAppDelete.ts deleted file mode 100644 index 37f7b0e26..000000000 --- a/examples/ApiAppDelete.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppDelete(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppDeleteExample.cs b/examples/ApiAppDeleteExample.cs new file mode 100644 index 000000000..87235a6a3 --- /dev/null +++ b/examples/ApiAppDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new ApiAppApi(config).ApiAppDelete( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppDeleteExample.java b/examples/ApiAppDeleteExample.java new file mode 100644 index 000000000..f9f7c5c9f --- /dev/null +++ b/examples/ApiAppDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppDeleteExample.php b/examples/ApiAppDeleteExample.php new file mode 100644 index 000000000..0734efaf9 --- /dev/null +++ b/examples/ApiAppDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppDelete( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppDelete: {$e->getMessage()}"; +} diff --git a/examples/ApiAppDeleteExample.py b/examples/ApiAppDeleteExample.py new file mode 100644 index 000000000..bcfe5d65b --- /dev/null +++ b/examples/ApiAppDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.ApiAppApi(api_client).api_app_delete( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_delete: %s\n" % e) diff --git a/examples/ApiAppDeleteExample.rb b/examples/ApiAppDeleteExample.rb new file mode 100644 index 000000000..def7fb657 --- /dev/null +++ b/examples/ApiAppDeleteExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::ApiAppApi.new.api_app_delete( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_delete: #{e}" +end diff --git a/examples/ApiAppDelete.sh b/examples/ApiAppDeleteExample.sh similarity index 100% rename from examples/ApiAppDelete.sh rename to examples/ApiAppDeleteExample.sh diff --git a/examples/ApiAppDeleteExample.ts b/examples/ApiAppDeleteExample.ts new file mode 100644 index 000000000..1ffefb975 --- /dev/null +++ b/examples/ApiAppDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppDelete:"); + console.log(error.body); +}); diff --git a/examples/ApiAppGet.cs b/examples/ApiAppGet.cs deleted file mode 100644 index 260e5072e..000000000 --- a/examples/ApiAppGet.cs +++ /dev/null @@ -1,34 +0,0 @@ -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try - { - var result = apiAppApi.ApiAppGet(clientId); - 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/ApiAppGet.java b/examples/ApiAppGet.java deleted file mode 100644 index 5d3a4bbd9..000000000 --- a/examples/ApiAppGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppGet(clientId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppGet.js b/examples/ApiAppGet.js deleted file mode 100644 index e300219e7..000000000 --- a/examples/ApiAppGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppGet(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppGet.php b/examples/ApiAppGet.php deleted file mode 100644 index 4372cd629..000000000 --- a/examples/ApiAppGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $result = $apiAppApi->apiAppGet($clientId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppGet.py b/examples/ApiAppGet.py deleted file mode 100644 index 07330bf35..000000000 --- a/examples/ApiAppGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - response = api_app_api.api_app_get(client_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppGet.rb b/examples/ApiAppGet.rb deleted file mode 100644 index 37011b33b..000000000 --- a/examples/ApiAppGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_get(client_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppGet.ts b/examples/ApiAppGet.ts deleted file mode 100644 index e300219e7..000000000 --- a/examples/ApiAppGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppGet(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppGetExample.cs b/examples/ApiAppGetExample.cs new file mode 100644 index 000000000..8bbf80af4 --- /dev/null +++ b/examples/ApiAppGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppGet( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppGetExample.java b/examples/ApiAppGetExample.java new file mode 100644 index 000000000..6a8330449 --- /dev/null +++ b/examples/ApiAppGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppGetExample.php b/examples/ApiAppGetExample.php new file mode 100644 index 000000000..f4dcc571b --- /dev/null +++ b/examples/ApiAppGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppGet( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppGet: {$e->getMessage()}"; +} diff --git a/examples/AccountGet.py b/examples/ApiAppGetExample.py similarity index 50% rename from examples/AccountGet.py rename to examples/ApiAppGetExample.py index 659cb62bf..0eee76c6a 100644 --- a/examples/AccountGet.py +++ b/examples/ApiAppGetExample.py @@ -1,19 +1,20 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - try: - response = account_api.account_get(email_address="jack@example.com") + response = api.ApiAppApi(api_client).api_app_get( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_get: %s\n" % e) diff --git a/examples/ApiAppGetExample.rb b/examples/ApiAppGetExample.rb new file mode 100644 index 000000000..f40c92b55 --- /dev/null +++ b/examples/ApiAppGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_get( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_get: #{e}" +end diff --git a/examples/ApiAppGet.sh b/examples/ApiAppGetExample.sh similarity index 100% rename from examples/ApiAppGet.sh rename to examples/ApiAppGetExample.sh diff --git a/examples/ApiAppGetExample.ts b/examples/ApiAppGetExample.ts new file mode 100644 index 000000000..4899769af --- /dev/null +++ b/examples/ApiAppGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppGet:"); + console.log(error.body); +}); diff --git a/examples/ApiAppList.cs b/examples/ApiAppList.cs deleted file mode 100644 index 094fb3b96..000000000 --- a/examples/ApiAppList.cs +++ /dev/null @@ -1,35 +0,0 @@ -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var page = 1; - var pageSize = 2; - - try - { - var result = apiAppApi.ApiAppList(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/ApiAppList.java b/examples/ApiAppList.java deleted file mode 100644 index e16df1a70..000000000 --- a/examples/ApiAppList.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - ApiAppListResponse result = apiAppApi.apiAppList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppList.js b/examples/ApiAppList.js deleted file mode 100644 index 46638ebe7..000000000 --- a/examples/ApiAppList.js +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 2; - -const result = apiAppApi.apiAppList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppList.php b/examples/ApiAppList.php deleted file mode 100644 index 9fb6cca9e..000000000 --- a/examples/ApiAppList.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$page = 1; -$pageSize = 2; - -try { - $result = $apiAppApi->apiAppList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppList.py b/examples/ApiAppList.py deleted file mode 100644 index 6c6ada0c8..000000000 --- a/examples/ApiAppList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - page = 1 - page_size = 2 - - try: - response = api_app_api.api_app_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppList.rb b/examples/ApiAppList.rb deleted file mode 100644 index fa0d767f5..000000000 --- a/examples/ApiAppList.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -page = 1 -page_size = 2 - -begin - result = api_app_api.api_app_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppList.ts b/examples/ApiAppList.ts deleted file mode 100644 index 46638ebe7..000000000 --- a/examples/ApiAppList.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 2; - -const result = apiAppApi.apiAppList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppListExample.cs b/examples/ApiAppListExample.cs new file mode 100644 index 000000000..be9060253 --- /dev/null +++ b/examples/ApiAppListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppListExample.java b/examples/ApiAppListExample.java new file mode 100644 index 000000000..5f023c890 --- /dev/null +++ b/examples/ApiAppListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppListExample.php b/examples/ApiAppListExample.php new file mode 100644 index 000000000..6e9a8e5cb --- /dev/null +++ b/examples/ApiAppListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppList: {$e->getMessage()}"; +} diff --git a/examples/ApiAppListExample.py b/examples/ApiAppListExample.py new file mode 100644 index 000000000..c0bca67da --- /dev/null +++ b/examples/ApiAppListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.ApiAppApi(api_client).api_app_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_list: %s\n" % e) diff --git a/examples/ApiAppListExample.rb b/examples/ApiAppListExample.rb new file mode 100644 index 000000000..3e776c659 --- /dev/null +++ b/examples/ApiAppListExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_list: #{e}" +end diff --git a/examples/ApiAppList.sh b/examples/ApiAppListExample.sh similarity index 100% rename from examples/ApiAppList.sh rename to examples/ApiAppListExample.sh diff --git a/examples/ApiAppListExample.ts b/examples/ApiAppListExample.ts new file mode 100644 index 000000000..7304a9d1c --- /dev/null +++ b/examples/ApiAppListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppList:"); + console.log(error.body); +}); diff --git a/examples/ApiAppUpdate.cs b/examples/ApiAppUpdate.cs deleted file mode 100644 index 4bca7ccc4..000000000 --- a/examples/ApiAppUpdate.cs +++ /dev/null @@ -1,61 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var oauth = new SubOAuth( - callbackUrl: "https://example.com/oauth", - scopes: new List() { - SubOAuth.ScopesEnum.BasicAccountInfo, - SubOAuth.ScopesEnum.RequestSignature - } - ); - - var whiteLabelingOptions = new SubWhiteLabelingOptions( - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff" - ); - - var customLogoFile = new FileStream( - "CustomLogoFile.png", - FileMode.Open - ); - - var data = new ApiAppUpdateRequest( - name: "My Production App", - domains: new List(){"example.com"}, - oauth: oauth, - whiteLabelingOptions: whiteLabelingOptions, - customLogoFile: customLogoFile - ); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try - { - var result = apiAppApi.ApiAppUpdate(clientId, 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/examples/ApiAppUpdate.java b/examples/ApiAppUpdate.java deleted file mode 100644 index a65617313..000000000 --- a/examples/ApiAppUpdate.java +++ /dev/null @@ -1,53 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of(SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppUpdateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppUpdate(clientId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppUpdate.js b/examples/ApiAppUpdate.js deleted file mode 100644 index 940878909..000000000 --- a/examples/ApiAppUpdate.js +++ /dev/null @@ -1,32 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const whiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data = { - name: "New Name", - callbackUrl: "http://example.com/dropboxsign", - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - whiteLabelingOptions, -}; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppUpdate(clientId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppUpdate.php b/examples/ApiAppUpdate.php deleted file mode 100644 index 60520cccc..000000000 --- a/examples/ApiAppUpdate.php +++ /dev/null @@ -1,36 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") - ->setPrimaryButtonTextColor("#ffffff"); - -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); -$data->setName("New Name") - ->setCallbackUrl("https://example.com/dropboxsign") - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $result = $apiAppApi->apiAppUpdate($clientId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppUpdate.py b/examples/ApiAppUpdate.py deleted file mode 100644 index 38f812095..000000000 --- a/examples/ApiAppUpdate.py +++ /dev/null @@ -1,35 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - white_labeling_options = models.SubWhiteLabelingOptions( - primary_button_color="#00b3e6", - primary_button_text_color="#ffffff", - ) - - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppUpdateRequest( - name="New Name", - callback_url="https://example.com/dropboxsign", - white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, - ) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - response = api_app_api.api_app_update(client_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppUpdate.rb b/examples/ApiAppUpdate.rb deleted file mode 100644 index 940f70c78..000000000 --- a/examples/ApiAppUpdate.rb +++ /dev/null @@ -1,32 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new -white_labeling_options.primary_button_color = "#00b3e6" -white_labeling_options.primary_button_text_color = "#ffffff" - -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppUpdateRequest.new -data.name = "New Name" -data.callback_url = "https://example.com/dropboxsign" -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_update(client_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppUpdate.ts b/examples/ApiAppUpdate.ts deleted file mode 100644 index a53f3f1c0..000000000 --- a/examples/ApiAppUpdate.ts +++ /dev/null @@ -1,32 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data: DropboxSign.ApiAppUpdateRequest = { - name: "New Name", - callbackUrl: "https://example.com/dropboxsign", - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - whiteLabelingOptions, -}; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppUpdate(clientId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppUpdateExample.cs b/examples/ApiAppUpdateExample.cs new file mode 100644 index 000000000..3eb03a1bf --- /dev/null +++ b/examples/ApiAppUpdateExample.cs @@ -0,0 +1,63 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppUpdateRequest = new ApiAppUpdateRequest( + callbackUrl: "https://example.com/dropboxsign", + name: "New Name", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppUpdate( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9", + apiAppUpdateRequest: apiAppUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppUpdateExample.java b/examples/ApiAppUpdateExample.java new file mode 100644 index 000000000..19eb17192 --- /dev/null +++ b/examples/ApiAppUpdateExample.java @@ -0,0 +1,62 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppUpdateExample.php b/examples/ApiAppUpdateExample.php new file mode 100644 index 000000000..30c22c4eb --- /dev/null +++ b/examples/ApiAppUpdateExample.php @@ -0,0 +1,44 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_update_request = (new Dropbox\Sign\Model\ApiAppUpdateRequest()) + ->setCallbackUrl("https://example.com/dropboxsign") + ->setName("New Name") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppUpdate( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request: $api_app_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppUpdate: {$e->getMessage()}"; +} diff --git a/examples/ApiAppUpdateExample.py b/examples/ApiAppUpdateExample.py new file mode 100644 index 000000000..00212198f --- /dev/null +++ b/examples/ApiAppUpdateExample.py @@ -0,0 +1,45 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + oauth = models.SubOAuth( + callback_url="https://example.com/oauth", + scopes=[ + "basic_account_info", + "request_signature", + ], + ) + + white_labeling_options = models.SubWhiteLabelingOptions( + primary_button_color="#00b3e6", + primary_button_text_color="#ffffff", + ) + + api_app_update_request = models.ApiAppUpdateRequest( + callback_url="https://example.com/dropboxsign", + name="New Name", + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), + oauth=oauth, + white_labeling_options=white_labeling_options, + ) + + try: + response = api.ApiAppApi(api_client).api_app_update( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request=api_app_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_update: %s\n" % e) diff --git a/examples/ApiAppUpdateExample.rb b/examples/ApiAppUpdateExample.rb new file mode 100644 index 000000000..e973b3520 --- /dev/null +++ b/examples/ApiAppUpdateExample.rb @@ -0,0 +1,39 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] + +white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new +white_labeling_options.primary_button_color = "#00b3e6" +white_labeling_options.primary_button_text_color = "#ffffff" + +api_app_update_request = Dropbox::Sign::ApiAppUpdateRequest.new +api_app_update_request.callback_url = "https://example.com/dropboxsign" +api_app_update_request.name = "New Name" +api_app_update_request.domains = [ + "example.com", +] +api_app_update_request.custom_logo_file = File.new("CustomLogoFile.png", "r") +api_app_update_request.oauth = oauth +api_app_update_request.white_labeling_options = white_labeling_options + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_update( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + api_app_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_update: #{e}" +end diff --git a/examples/ApiAppUpdate.sh b/examples/ApiAppUpdateExample.sh similarity index 100% rename from examples/ApiAppUpdate.sh rename to examples/ApiAppUpdateExample.sh diff --git a/examples/ApiAppUpdateExample.ts b/examples/ApiAppUpdateExample.ts new file mode 100644 index 000000000..fa8937223 --- /dev/null +++ b/examples/ApiAppUpdateExample.ts @@ -0,0 +1,38 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppUpdateRequest = new models.ApiAppUpdateRequest(); +apiAppUpdateRequest.callbackUrl = "https://example.com/dropboxsign"; +apiAppUpdateRequest.name = "New Name"; +apiAppUpdateRequest.domains = [ + "example.com", +]; +apiAppUpdateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppUpdateRequest.oauth = oauth; +apiAppUpdateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppUpdate:"); + console.log(error.body); +}); diff --git a/examples/BulkSendJobGet.cs b/examples/BulkSendJobGet.cs deleted file mode 100644 index 42a805c58..000000000 --- a/examples/BulkSendJobGet.cs +++ /dev/null @@ -1,35 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var bulkSendJobApi = new BulkSendJobApi(config); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try - { - var result = bulkSendJobApi.BulkSendJobGet(bulkSendJobId); - 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/BulkSendJobGet.java b/examples/BulkSendJobGet.java deleted file mode 100644 index d79a46164..000000000 --- a/examples/BulkSendJobGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try { - BulkSendJobGetResponse result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/BulkSendJobGet.js b/examples/BulkSendJobGet.js deleted file mode 100644 index 7a1f5e043..000000000 --- a/examples/BulkSendJobGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobGet.php b/examples/BulkSendJobGet.php deleted file mode 100644 index 3b93304ce..000000000 --- a/examples/BulkSendJobGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -try { - $result = $bulkSendJobApi->bulkSendJobGet($bulkSendJobId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/BulkSendJobGet.py b/examples/BulkSendJobGet.py deleted file mode 100644 index ed92e9751..000000000 --- a/examples/BulkSendJobGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - - try: - response = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/BulkSendJobGet.rb b/examples/BulkSendJobGet.rb deleted file mode 100644 index 8ef33b282..000000000 --- a/examples/BulkSendJobGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - -begin - result = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/BulkSendJobGet.ts b/examples/BulkSendJobGet.ts deleted file mode 100644 index 7a1f5e043..000000000 --- a/examples/BulkSendJobGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobGetExample.cs b/examples/BulkSendJobGetExample.cs new file mode 100644 index 000000000..baa383c93 --- /dev/null +++ b/examples/BulkSendJobGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobGet( + bulkSendJobId: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/BulkSendJobGetExample.java b/examples/BulkSendJobGetExample.java new file mode 100644 index 000000000..a90b43560 --- /dev/null +++ b/examples/BulkSendJobGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/BulkSendJobGetExample.php b/examples/BulkSendJobGetExample.php new file mode 100644 index 000000000..8b74043d9 --- /dev/null +++ b/examples/BulkSendJobGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobGet( + bulk_send_job_id: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobGet: {$e->getMessage()}"; +} diff --git a/examples/BulkSendJobGetExample.py b/examples/BulkSendJobGetExample.py new file mode 100644 index 000000000..58b865737 --- /dev/null +++ b/examples/BulkSendJobGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_get( + bulk_send_job_id="6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e) diff --git a/examples/BulkSendJobGetExample.rb b/examples/BulkSendJobGetExample.rb new file mode 100644 index 000000000..bf4b58570 --- /dev/null +++ b/examples/BulkSendJobGetExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_get( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", # bulk_send_job_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}" +end diff --git a/examples/BulkSendJobGet.sh b/examples/BulkSendJobGetExample.sh similarity index 100% rename from examples/BulkSendJobGet.sh rename to examples/BulkSendJobGetExample.sh diff --git a/examples/BulkSendJobGetExample.ts b/examples/BulkSendJobGetExample.ts new file mode 100644 index 000000000..9c3e43eb9 --- /dev/null +++ b/examples/BulkSendJobGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobGet:"); + console.log(error.body); +}); diff --git a/examples/BulkSendJobList.cs b/examples/BulkSendJobList.cs deleted file mode 100644 index 4bdbb0b59..000000000 --- a/examples/BulkSendJobList.cs +++ /dev/null @@ -1,36 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var bulkSendJobApi = new BulkSendJobApi(config); - - var page = 1; - var pageSize = 20; - - try - { - var result = bulkSendJobApi.BulkSendJobList(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/BulkSendJobList.java b/examples/BulkSendJobList.java deleted file mode 100644 index 866f3352c..000000000 --- a/examples/BulkSendJobList.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var page = 1; - var pageSize = 20; - - try { - BulkSendJobListResponse result = bulkSendJobApi.bulkSendJobList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/BulkSendJobList.js b/examples/BulkSendJobList.js deleted file mode 100644 index ceb35707d..000000000 --- a/examples/BulkSendJobList.js +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 20; - -const result = bulkSendJobApi.bulkSendJobList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobList.php b/examples/BulkSendJobList.php deleted file mode 100644 index 9e6639af1..000000000 --- a/examples/BulkSendJobList.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$page = 1; -$pageSize = 20; - -try { - $result = $bulkSendJobApi->bulkSendJobList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/BulkSendJobList.py b/examples/BulkSendJobList.py deleted file mode 100644 index 61bf5117f..000000000 --- a/examples/BulkSendJobList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - page = 1 - page_size = 20 - - try: - response = bulk_send_job_api.bulk_send_job_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/BulkSendJobList.rb b/examples/BulkSendJobList.rb deleted file mode 100644 index cb64c5df5..000000000 --- a/examples/BulkSendJobList.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -page = 1 -page_size = 20 - -begin - result = bulk_send_job_api.bulk_send_job_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/BulkSendJobList.ts b/examples/BulkSendJobList.ts deleted file mode 100644 index ceb35707d..000000000 --- a/examples/BulkSendJobList.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 20; - -const result = bulkSendJobApi.bulkSendJobList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobListExample.cs b/examples/BulkSendJobListExample.cs new file mode 100644 index 000000000..d84e42e04 --- /dev/null +++ b/examples/BulkSendJobListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/BulkSendJobListExample.java b/examples/BulkSendJobListExample.java new file mode 100644 index 000000000..fc5d223e3 --- /dev/null +++ b/examples/BulkSendJobListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/BulkSendJobListExample.php b/examples/BulkSendJobListExample.php new file mode 100644 index 000000000..9a566d561 --- /dev/null +++ b/examples/BulkSendJobListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobList: {$e->getMessage()}"; +} diff --git a/examples/BulkSendJobListExample.py b/examples/BulkSendJobListExample.py new file mode 100644 index 000000000..cb688f24d --- /dev/null +++ b/examples/BulkSendJobListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_list: %s\n" % e) diff --git a/examples/BulkSendJobListExample.rb b/examples/BulkSendJobListExample.rb new file mode 100644 index 000000000..60e8c1b50 --- /dev/null +++ b/examples/BulkSendJobListExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}" +end diff --git a/examples/BulkSendJobList.sh b/examples/BulkSendJobListExample.sh similarity index 100% rename from examples/BulkSendJobList.sh rename to examples/BulkSendJobListExample.sh diff --git a/examples/BulkSendJobListExample.ts b/examples/BulkSendJobListExample.ts new file mode 100644 index 000000000..4f8b1b33b --- /dev/null +++ b/examples/BulkSendJobListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobList:"); + console.log(error.body); +}); diff --git a/examples/EmbeddedEditUrl.cs b/examples/EmbeddedEditUrl.cs deleted file mode 100644 index 87479129f..000000000 --- a/examples/EmbeddedEditUrl.cs +++ /dev/null @@ -1,40 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var embeddedApi = new EmbeddedApi(config); - - var data = new EmbeddedEditUrlRequest( - ccRoles: new List(){""}, - mergeFields: new List() - ); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try - { - var result = embeddedApi.EmbeddedEditUrl(templateId, 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/examples/EmbeddedEditUrl.java b/examples/EmbeddedEditUrl.java deleted file mode 100644 index 65a52a96a..000000000 --- a/examples/EmbeddedEditUrl.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var data = new EmbeddedEditUrlRequest() - .ccRoles(List.of("")) - .mergeFields(List.of()); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try { - EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/EmbeddedEditUrl.js b/examples/EmbeddedEditUrl.js deleted file mode 100644 index a3fab55d9..000000000 --- a/examples/EmbeddedEditUrl.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - ccRoles: [""], - mergeFields: [], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = embeddedApi.embeddedEditUrl(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedEditUrl.php b/examples/EmbeddedEditUrl.php deleted file mode 100644 index 452afd315..000000000 --- a/examples/EmbeddedEditUrl.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$data = new Dropbox\Sign\Model\EmbeddedEditUrlRequest(); -$data->setCcRoles([""]) - ->setMergeFields([]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $embeddedApi->embeddedEditUrl($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/EmbeddedEditUrl.py b/examples/EmbeddedEditUrl.py deleted file mode 100644 index dd657233d..000000000 --- a/examples/EmbeddedEditUrl.py +++ /dev/null @@ -1,26 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - data = models.EmbeddedEditUrlRequest( - cc_roles=[""], - merge_fields=[], - ) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = embedded_api.embedded_edit_url(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/EmbeddedEditUrl.rb b/examples/EmbeddedEditUrl.rb deleted file mode 100644 index 0eef4c2cf..000000000 --- a/examples/EmbeddedEditUrl.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api = Dropbox::Sign::EmbeddedApi.new - -data = Dropbox::Sign::EmbeddedEditUrlRequest.new -data.cc_roles = [""] -data.merge_fields = [] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = embedded_api.embedded_edit_url(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/EmbeddedEditUrl.ts b/examples/EmbeddedEditUrl.ts deleted file mode 100644 index c6c93c259..000000000 --- a/examples/EmbeddedEditUrl.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.EmbeddedEditUrlRequest = { - ccRoles: [""], - mergeFields: [], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = embeddedApi.embeddedEditUrl(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedEditUrlExample.cs b/examples/EmbeddedEditUrlExample.cs new file mode 100644 index 000000000..f951e1751 --- /dev/null +++ b/examples/EmbeddedEditUrlExample.cs @@ -0,0 +1,45 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedEditUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var mergeFields = new List(); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest( + ccRoles: [ + "", + ], + mergeFields: mergeFields + ); + + try + { + var response = new EmbeddedApi(config).EmbeddedEditUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + embeddedEditUrlRequest: embeddedEditUrlRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedEditUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/EmbeddedEditUrlExample.java b/examples/EmbeddedEditUrlExample.java new file mode 100644 index 000000000..81139263b --- /dev/null +++ b/examples/EmbeddedEditUrlExample.java @@ -0,0 +1,49 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedEditUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/EmbeddedEditUrlExample.php b/examples/EmbeddedEditUrlExample.php new file mode 100644 index 000000000..cae4929eb --- /dev/null +++ b/examples/EmbeddedEditUrlExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$merge_fields = [ +]; + +$embedded_edit_url_request = (new Dropbox\Sign\Model\EmbeddedEditUrlRequest()) + ->setCcRoles([ + "", + ]) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedEditUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request: $embedded_edit_url_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedEditUrl: {$e->getMessage()}"; +} diff --git a/examples/EmbeddedEditUrlExample.py b/examples/EmbeddedEditUrlExample.py new file mode 100644 index 000000000..0c8577780 --- /dev/null +++ b/examples/EmbeddedEditUrlExample.py @@ -0,0 +1,31 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + merge_fields = [ + ] + + embedded_edit_url_request = models.EmbeddedEditUrlRequest( + cc_roles=[ + "", + ], + merge_fields=merge_fields, + ) + + try: + response = api.EmbeddedApi(api_client).embedded_edit_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request=embedded_edit_url_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_edit_url: %s\n" % e) diff --git a/examples/EmbeddedEditUrlExample.rb b/examples/EmbeddedEditUrlExample.rb new file mode 100644 index 000000000..8c110f69d --- /dev/null +++ b/examples/EmbeddedEditUrlExample.rb @@ -0,0 +1,27 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +merge_fields = [ +] + +embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new +embedded_edit_url_request.cc_roles = [ + "", +] +embedded_edit_url_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::EmbeddedApi.new.embedded_edit_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + embedded_edit_url_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}" +end diff --git a/examples/EmbeddedEditUrl.sh b/examples/EmbeddedEditUrlExample.sh similarity index 100% rename from examples/EmbeddedEditUrl.sh rename to examples/EmbeddedEditUrlExample.sh diff --git a/examples/EmbeddedEditUrlExample.ts b/examples/EmbeddedEditUrlExample.ts new file mode 100644 index 000000000..bca3980cf --- /dev/null +++ b/examples/EmbeddedEditUrlExample.ts @@ -0,0 +1,26 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const mergeFields = [ +]; + +const embeddedEditUrlRequest = new models.EmbeddedEditUrlRequest(); +embeddedEditUrlRequest.ccRoles = [ + "", +]; +embeddedEditUrlRequest.mergeFields = mergeFields; + +apiCaller.embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedEditUrl:"); + console.log(error.body); +}); diff --git a/examples/EmbeddedSignUrl.cs b/examples/EmbeddedSignUrl.cs deleted file mode 100644 index d8197bfeb..000000000 --- a/examples/EmbeddedSignUrl.cs +++ /dev/null @@ -1,35 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var embeddedApi = new EmbeddedApi(config); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try - { - var result = embeddedApi.EmbeddedSignUrl(signatureId); - 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/EmbeddedSignUrl.java b/examples/EmbeddedSignUrl.java deleted file mode 100644 index 2ab5869ea..000000000 --- a/examples/EmbeddedSignUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try { - EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/EmbeddedSignUrl.js b/examples/EmbeddedSignUrl.js deleted file mode 100644 index e69bca023..000000000 --- a/examples/EmbeddedSignUrl.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -const result = embeddedApi.embeddedSignUrl(signatureId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedSignUrl.php b/examples/EmbeddedSignUrl.php deleted file mode 100644 index 7b838a164..000000000 --- a/examples/EmbeddedSignUrl.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -try { - $result = $embeddedApi->embeddedSignUrl($signatureId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/EmbeddedSignUrl.py b/examples/EmbeddedSignUrl.py deleted file mode 100644 index 64d5c20e1..000000000 --- a/examples/EmbeddedSignUrl.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - - try: - response = embedded_api.embedded_sign_url(signature_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/EmbeddedSignUrl.rb b/examples/EmbeddedSignUrl.rb deleted file mode 100644 index e23571a5c..000000000 --- a/examples/EmbeddedSignUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api = Dropbox::Sign::EmbeddedApi.new - -signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - -begin - result = embedded_api.embedded_sign_url(signature_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/EmbeddedSignUrl.ts b/examples/EmbeddedSignUrl.ts deleted file mode 100644 index e69bca023..000000000 --- a/examples/EmbeddedSignUrl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -const result = embeddedApi.embeddedSignUrl(signatureId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedSignUrlExample.cs b/examples/EmbeddedSignUrlExample.cs new file mode 100644 index 000000000..a800f0b04 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedSignUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new EmbeddedApi(config).EmbeddedSignUrl( + signatureId: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedSignUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/EmbeddedSignUrlExample.java b/examples/EmbeddedSignUrlExample.java new file mode 100644 index 000000000..8b58ba353 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedSignUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedSignUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/EmbeddedSignUrlExample.php b/examples/EmbeddedSignUrlExample.php new file mode 100644 index 000000000..b055ac6ed --- /dev/null +++ b/examples/EmbeddedSignUrlExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedSignUrl( + signature_id: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedSignUrl: {$e->getMessage()}"; +} diff --git a/examples/EmbeddedSignUrlExample.py b/examples/EmbeddedSignUrlExample.py new file mode 100644 index 000000000..903945d90 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.EmbeddedApi(api_client).embedded_sign_url( + signature_id="50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_sign_url: %s\n" % e) diff --git a/examples/EmbeddedSignUrlExample.rb b/examples/EmbeddedSignUrlExample.rb new file mode 100644 index 000000000..dd08e5a6f --- /dev/null +++ b/examples/EmbeddedSignUrlExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::EmbeddedApi.new.embedded_sign_url( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}" +end diff --git a/examples/EmbeddedSignUrl.sh b/examples/EmbeddedSignUrlExample.sh similarity index 100% rename from examples/EmbeddedSignUrl.sh rename to examples/EmbeddedSignUrlExample.sh diff --git a/examples/EmbeddedSignUrlExample.ts b/examples/EmbeddedSignUrlExample.ts new file mode 100644 index 000000000..ec7da0536 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", // signatureId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedSignUrl:"); + console.log(error.body); +}); diff --git a/examples/EventCallback.cs b/examples/EventCallbackExample.cs similarity index 91% rename from examples/EventCallback.cs rename to examples/EventCallbackExample.cs index bc287ff43..c8610a8fe 100644 --- a/examples/EventCallback.cs +++ b/examples/EventCallbackExample.cs @@ -1,10 +1,13 @@ +using System.Collections.Generic; using Newtonsoft.Json; using Dropbox.Sign.Model; using Dropbox.Sign; -public class Example +namespace Dropbox.SignSandbox; + +public class EventCallbackExample { - public static void Main() + public static void Run() { // use your API key var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; diff --git a/examples/EventCallback.java b/examples/EventCallbackExample.java similarity index 97% rename from examples/EventCallback.java rename to examples/EventCallbackExample.java index d712408f1..37d245133 100644 --- a/examples/EventCallback.java +++ b/examples/EventCallbackExample.java @@ -4,7 +4,7 @@ import java.util.HashMap; -public class Example { +public class EventCallbackExample { public static void main(String[] args) throws Exception { // use your API key var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; diff --git a/examples/EventCallback.php b/examples/EventCallbackExample.php similarity index 91% rename from examples/EventCallback.php rename to examples/EventCallbackExample.php index 68ce6540f..4a21d5cbf 100644 --- a/examples/EventCallback.php +++ b/examples/EventCallbackExample.php @@ -1,6 +1,10 @@ { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxDelete.php b/examples/FaxDelete.php deleted file mode 100644 index a5c62f5e9..000000000 --- a/examples/FaxDelete.php +++ /dev/null @@ -1,18 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -try { - $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxDelete.py b/examples/FaxDelete.py deleted file mode 100644 index adf2a5da8..000000000 --- a/examples/FaxDelete.py +++ /dev/null @@ -1,16 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - try: - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxDelete.rb b/examples/FaxDelete.rb deleted file mode 100644 index f68be3440..000000000 --- a/examples/FaxDelete.rb +++ /dev/null @@ -1,14 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -begin - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxDelete.ts b/examples/FaxDelete.ts deleted file mode 100644 index 38492bd21..000000000 --- a/examples/FaxDelete.ts +++ /dev/null @@ -1,13 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineDelete.cs b/examples/FaxDeleteExample.cs similarity index 57% rename from examples/FaxLineDelete.cs rename to examples/FaxDeleteExample.cs index 810e268a3..aa39f496d 100644 --- a/examples/FaxLineDelete.cs +++ b/examples/FaxDeleteExample.cs @@ -1,30 +1,30 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineDeleteRequest( - number: "[FAX_NUMBER]" - ); - try { - faxLineApi.FaxLineDelete(data); + new FaxApi(config).FaxDelete( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/FaxDeleteExample.java b/examples/FaxDeleteExample.java new file mode 100644 index 000000000..ac5fc888d --- /dev/null +++ b/examples/FaxDeleteExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxDeleteExample.php b/examples/FaxDeleteExample.php new file mode 100644 index 000000000..96ba3c0d7 --- /dev/null +++ b/examples/FaxDeleteExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\FaxApi(config: $config))->faxDelete( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxDelete: {$e->getMessage()}"; +} diff --git a/examples/FaxDeleteExample.py b/examples/FaxDeleteExample.py new file mode 100644 index 000000000..76774d75b --- /dev/null +++ b/examples/FaxDeleteExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.FaxApi(api_client).fax_delete( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling FaxApi#fax_delete: %s\n" % e) diff --git a/examples/FaxDeleteExample.rb b/examples/FaxDeleteExample.rb new file mode 100644 index 000000000..6caa9d681 --- /dev/null +++ b/examples/FaxDeleteExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::FaxApi.new.fax_delete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_delete: #{e}" +end diff --git a/examples/FaxDelete.sh b/examples/FaxDeleteExample.sh similarity index 100% rename from examples/FaxDelete.sh rename to examples/FaxDeleteExample.sh diff --git a/examples/FaxDeleteExample.ts b/examples/FaxDeleteExample.ts new file mode 100644 index 000000000..3afd7a63b --- /dev/null +++ b/examples/FaxDeleteExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).catch(error => { + console.log("Exception when calling FaxApi#faxDelete:"); + console.log(error.body); +}); diff --git a/examples/FaxFiles.cs b/examples/FaxFiles.cs deleted file mode 100644 index fbaf4166e..000000000 --- a/examples/FaxFiles.cs +++ /dev/null @@ -1,34 +0,0 @@ -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/FaxFiles.java b/examples/FaxFiles.java deleted file mode 100644 index bd6dcc5df..000000000 --- a/examples/FaxFiles.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = faxApi.faxFiles(faxId); - result.renameTo(new File("file_response.pdf"));; - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxFiles.js b/examples/FaxFiles.js deleted file mode 100644 index d7390cf60..000000000 --- a/examples/FaxFiles.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = faxApi.faxFiles(faxId); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxFiles.php b/examples/FaxFiles.php deleted file mode 100644 index d543eea9c..000000000 --- a/examples/FaxFiles.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $faxApi->faxFiles($faxId); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxFiles.py b/examples/FaxFiles.py deleted file mode 100644 index 110a0f7b5..000000000 --- a/examples/FaxFiles.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = fax_api.fax_files(fax_id) - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxFiles.rb b/examples/FaxFiles.rb deleted file mode 100644 index 8f4955da8..000000000 --- a/examples/FaxFiles.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - file_bin = fax_api.fax_files(data) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxFiles.ts b/examples/FaxFiles.ts deleted file mode 100644 index d7390cf60..000000000 --- a/examples/FaxFiles.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = faxApi.faxFiles(faxId); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxFilesExample.cs b/examples/FaxFilesExample.cs new file mode 100644 index 000000000..278b90f8b --- /dev/null +++ b/examples/FaxFilesExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxFiles( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxFilesExample.java b/examples/FaxFilesExample.java new file mode 100644 index 000000000..1d2e62fac --- /dev/null +++ b/examples/FaxFilesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxFilesExample.php b/examples/FaxFilesExample.php new file mode 100644 index 000000000..01322d769 --- /dev/null +++ b/examples/FaxFilesExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxFiles( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxFiles: {$e->getMessage()}"; +} diff --git a/examples/FaxFilesExample.py b/examples/FaxFilesExample.py new file mode 100644 index 000000000..4bc18d604 --- /dev/null +++ b/examples/FaxFilesExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxApi(api_client).fax_files( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling FaxApi#fax_files: %s\n" % e) diff --git a/examples/FaxFilesExample.rb b/examples/FaxFilesExample.rb new file mode 100644 index 000000000..b44d604c4 --- /dev/null +++ b/examples/FaxFilesExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_files: #{e}" +end diff --git a/examples/FaxFiles.sh b/examples/FaxFilesExample.sh similarity index 100% rename from examples/FaxFiles.sh rename to examples/FaxFilesExample.sh diff --git a/examples/FaxFilesExample.ts b/examples/FaxFilesExample.ts new file mode 100644 index 000000000..d4360710d --- /dev/null +++ b/examples/FaxFilesExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxFiles:"); + console.log(error.body); +}); diff --git a/examples/FaxGet.cs b/examples/FaxGet.cs deleted file mode 100644 index 6396e0c34..000000000 --- a/examples/FaxGet.cs +++ /dev/null @@ -1,31 +0,0 @@ -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/FaxGet.java b/examples/FaxGet.java deleted file mode 100644 index a9cc433df..000000000 --- a/examples/FaxGet.java +++ /dev/null @@ -1,27 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FaxGetResponse result = faxApi.faxGet(faxId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxGet.js b/examples/FaxGet.js deleted file mode 100644 index 8a1dbbfda..000000000 --- a/examples/FaxGet.js +++ /dev/null @@ -1,16 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -const result = faxApi.faxGet(faxId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxGet.php b/examples/FaxGet.php deleted file mode 100644 index 43b7a1f3e..000000000 --- a/examples/FaxGet.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $faxApi->faxGet($faxId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxGet.rb b/examples/FaxGet.rb deleted file mode 100644 index 64dc1c057..000000000 --- a/examples/FaxGet.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = fax_api.fax_get(fax_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxGet.ts b/examples/FaxGet.ts deleted file mode 100644 index 793f6e5d3..000000000 --- a/examples/FaxGet.ts +++ /dev/null @@ -1,16 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -const result = faxApi.faxGet(faxId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxGetExample.cs b/examples/FaxGetExample.cs new file mode 100644 index 000000000..8a15843d1 --- /dev/null +++ b/examples/FaxGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxGet( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxGetExample.java b/examples/FaxGetExample.java new file mode 100644 index 000000000..3db05bd4b --- /dev/null +++ b/examples/FaxGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxGetExample.php b/examples/FaxGetExample.php new file mode 100644 index 000000000..50bb7c865 --- /dev/null +++ b/examples/FaxGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxGet( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxGet: {$e->getMessage()}"; +} diff --git a/examples/FaxGet.py b/examples/FaxGetExample.py similarity index 50% rename from examples/FaxGet.py rename to examples/FaxGetExample.py index c56656833..e1288e656 100644 --- a/examples/FaxGet.py +++ b/examples/FaxGetExample.py @@ -1,19 +1,19 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = fax_api.fax_get(fax_id) + response = api.FaxApi(api_client).fax_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_get: %s\n" % e) diff --git a/examples/FaxGetExample.rb b/examples/FaxGetExample.rb new file mode 100644 index 000000000..692ae1c99 --- /dev/null +++ b/examples/FaxGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_get: #{e}" +end diff --git a/examples/FaxGet.sh b/examples/FaxGetExample.sh similarity index 100% rename from examples/FaxGet.sh rename to examples/FaxGetExample.sh diff --git a/examples/FaxGetExample.ts b/examples/FaxGetExample.ts new file mode 100644 index 000000000..56a87dbe7 --- /dev/null +++ b/examples/FaxGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxGet:"); + console.log(error.body); +}); diff --git a/examples/FaxLineAddUser.java b/examples/FaxLineAddUser.java deleted file mode 100644 index 34e455d5a..000000000 --- a/examples/FaxLineAddUser.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineAddUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineAddUser(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineAddUser.js b/examples/FaxLineAddUser.js deleted file mode 100644 index 84e1e2c0e..000000000 --- a/examples/FaxLineAddUser.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineAddUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAddUser.php b/examples/FaxLineAddUser.php deleted file mode 100644 index 8fb6c0fef..000000000 --- a/examples/FaxLineAddUser.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineAddUserRequest(); -$data->setNumber("[FAX_NUMBER]") - ->setEmailAddress("member@dropboxsign.com"); - -try { - $result = $faxLineApi->faxLineAddUser($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineAddUser.rb b/examples/FaxLineAddUser.rb deleted file mode 100644 index 1ad855373..000000000 --- a/examples/FaxLineAddUser.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineAddUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" - -begin - result = fax_line_api.fax_line_add_user(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineAddUser.ts b/examples/FaxLineAddUser.ts deleted file mode 100644 index e5d705e94..000000000 --- a/examples/FaxLineAddUser.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineAddUserRequest = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineAddUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAddUser.cs b/examples/FaxLineAddUserExample.cs similarity index 53% rename from examples/FaxLineAddUser.cs rename to examples/FaxLineAddUserExample.cs index de22f454f..cb9c642f7 100644 --- a/examples/FaxLineAddUser.cs +++ b/examples/FaxLineAddUserExample.cs @@ -1,32 +1,37 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineAddUserExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineAddUserRequest( + var faxLineAddUserRequest = new FaxLineAddUserRequest( number: "[FAX_NUMBER]", emailAddress: "member@dropboxsign.com" ); try { - var result = faxLineApi.FaxLineAddUser(data); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineAddUser( + faxLineAddUserRequest: faxLineAddUserRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAddUser: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/FaxLineAddUserExample.java b/examples/FaxLineAddUserExample.java new file mode 100644 index 000000000..f3883223f --- /dev/null +++ b/examples/FaxLineAddUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineAddUserExample.php b/examples/FaxLineAddUserExample.php new file mode 100644 index 000000000..cca56e766 --- /dev/null +++ b/examples/FaxLineAddUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_add_user_request = (new Dropbox\Sign\Model\FaxLineAddUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAddUser( + fax_line_add_user_request: $fax_line_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAddUser: {$e->getMessage()}"; +} diff --git a/examples/FaxLineRemoveUser.py b/examples/FaxLineAddUserExample.py similarity index 50% rename from examples/FaxLineRemoveUser.py rename to examples/FaxLineAddUserExample.py index d6929502b..255ac248b 100644 --- a/examples/FaxLineRemoveUser.py +++ b/examples/FaxLineAddUserExample.py @@ -1,22 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineRemoveUserRequest( + fax_line_add_user_request = models.FaxLineAddUserRequest( number="[FAX_NUMBER]", email_address="member@dropboxsign.com", ) try: - response = fax_line_api.fax_line_remove_user(data) + response = api.FaxLineApi(api_client).fax_line_add_user( + fax_line_add_user_request=fax_line_add_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_add_user: %s\n" % e) diff --git a/examples/FaxLineAddUserExample.rb b/examples/FaxLineAddUserExample.rb new file mode 100644 index 000000000..4d7f568bb --- /dev/null +++ b/examples/FaxLineAddUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_add_user_request = Dropbox::Sign::FaxLineAddUserRequest.new +fax_line_add_user_request.number = "[FAX_NUMBER]" +fax_line_add_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_add_user( + fax_line_add_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}" +end diff --git a/examples/FaxLineAddUser.sh b/examples/FaxLineAddUserExample.sh similarity index 100% rename from examples/FaxLineAddUser.sh rename to examples/FaxLineAddUserExample.sh diff --git a/examples/FaxLineAddUserExample.ts b/examples/FaxLineAddUserExample.ts new file mode 100644 index 000000000..468fe36a6 --- /dev/null +++ b/examples/FaxLineAddUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineAddUserRequest = new models.FaxLineAddUserRequest(); +faxLineAddUserRequest.number = "[FAX_NUMBER]"; +faxLineAddUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineAddUser( + faxLineAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAddUser:"); + console.log(error.body); +}); diff --git a/examples/FaxLineAreaCodeGet.java b/examples/FaxLineAreaCodeGet.java deleted file mode 100644 index 1df071ab9..000000000 --- a/examples/FaxLineAreaCodeGet.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineAreaCodeGetResponse result = faxLineApi.faxLineAreaCodeGet("US", "CA"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineAreaCodeGet.js b/examples/FaxLineAreaCodeGet.js deleted file mode 100644 index bfc908f18..000000000 --- a/examples/FaxLineAreaCodeGet.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineAreaCodeGet("US", "CA"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAreaCodeGet.php b/examples/FaxLineAreaCodeGet.php deleted file mode 100644 index c19f9e187..000000000 --- a/examples/FaxLineAreaCodeGet.php +++ /dev/null @@ -1,19 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineAreaCodeGet("US", "CA"); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineAreaCodeGet.rb b/examples/FaxLineAreaCodeGet.rb deleted file mode 100644 index 571fb4f58..000000000 --- a/examples/FaxLineAreaCodeGet.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_area_code_get("US", "CA") - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineAreaCodeGet.ts b/examples/FaxLineAreaCodeGet.ts deleted file mode 100644 index bfc908f18..000000000 --- a/examples/FaxLineAreaCodeGet.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineAreaCodeGet("US", "CA"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAreaCodeGetExample.cs b/examples/FaxLineAreaCodeGetExample.cs new file mode 100644 index 000000000..b2b60876b --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineAreaCodeGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAreaCodeGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineAreaCodeGetExample.java b/examples/FaxLineAreaCodeGetExample.java new file mode 100644 index 000000000..0f2055863 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineAreaCodeGetExample.php b/examples/FaxLineAreaCodeGetExample.php new file mode 100644 index 000000000..dfd46d313 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAreaCodeGet: {$e->getMessage()}"; +} diff --git a/examples/FaxLineAreaCodeGetExample.py b/examples/FaxLineAreaCodeGetExample.py new file mode 100644 index 000000000..a2752d8d6 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_area_code_get( + country="US", + state=None, + province=None, + city=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) diff --git a/examples/FaxLineAreaCodeGetExample.rb b/examples/FaxLineAreaCodeGetExample.rb new file mode 100644 index 000000000..75c3a3c3e --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get( + "US", # country + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}" +end diff --git a/examples/FaxLineAreaCodeGet.sh b/examples/FaxLineAreaCodeGetExample.sh similarity index 100% rename from examples/FaxLineAreaCodeGet.sh rename to examples/FaxLineAreaCodeGetExample.sh diff --git a/examples/FaxLineAreaCodeGetExample.ts b/examples/FaxLineAreaCodeGetExample.ts new file mode 100644 index 000000000..0abb378b3 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineAreaCodeGet( + "US", // country + undefined, // state + undefined, // province + undefined, // city +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAreaCodeGet:"); + console.log(error.body); +}); diff --git a/examples/FaxLineCreate.java b/examples/FaxLineCreate.java deleted file mode 100644 index fca101895..000000000 --- a/examples/FaxLineCreate.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineCreateRequest() - .areaCode(209) - .country("US"); - - try { - FaxLineResponse result = faxLineApi.faxLineCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineCreate.js b/examples/FaxLineCreate.js deleted file mode 100644 index c4ee72c59..000000000 --- a/examples/FaxLineCreate.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - areaCode: 209, - country: "US", -}; - -const result = faxLineApi.faxLineCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineCreate.php b/examples/FaxLineCreate.php deleted file mode 100644 index 27a0d2b8a..000000000 --- a/examples/FaxLineCreate.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineCreateRequest(); -$data->setAreaCode(209) - ->setCountry("US"); - -try { - $result = $faxLineApi->faxLineCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineCreate.py b/examples/FaxLineCreate.py deleted file mode 100644 index bcbd585ea..000000000 --- a/examples/FaxLineCreate.py +++ /dev/null @@ -1,22 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineCreateRequest( - area_code=209, - country="US", - ) - - try: - response = fax_line_api.fax_line_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineCreate.rb b/examples/FaxLineCreate.rb deleted file mode 100644 index 2619678ae..000000000 --- a/examples/FaxLineCreate.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineCreateRequest.new -data.area_code = 209 -data.country = "US" - -begin - result = fax_line_api.fax_line_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineCreate.ts b/examples/FaxLineCreate.ts deleted file mode 100644 index 6ceeb71da..000000000 --- a/examples/FaxLineCreate.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineCreateRequest = { - areaCode: 209, - country: "US", -}; - -const result = faxLineApi.faxLineCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineCreateExample.cs b/examples/FaxLineCreateExample.cs new file mode 100644 index 000000000..802ea4045 --- /dev/null +++ b/examples/FaxLineCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineCreateRequest = new FaxLineCreateRequest( + areaCode: 209, + country: FaxLineCreateRequest.CountryEnum.US + ); + + try + { + var response = new FaxLineApi(config).FaxLineCreate( + faxLineCreateRequest: faxLineCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineCreateExample.java b/examples/FaxLineCreateExample.java new file mode 100644 index 000000000..d1a1fa689 --- /dev/null +++ b/examples/FaxLineCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineCreateExample.php b/examples/FaxLineCreateExample.php new file mode 100644 index 000000000..0a5ef5ec6 --- /dev/null +++ b/examples/FaxLineCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_create_request = (new Dropbox\Sign\Model\FaxLineCreateRequest()) + ->setAreaCode(209) + ->setCountry(Dropbox\Sign\Model\FaxLineCreateRequest::COUNTRY_US); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineCreate( + fax_line_create_request: $fax_line_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineCreate: {$e->getMessage()}"; +} diff --git a/examples/FaxLineCreateExample.py b/examples/FaxLineCreateExample.py new file mode 100644 index 000000000..3f7be1223 --- /dev/null +++ b/examples/FaxLineCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_create_request = models.FaxLineCreateRequest( + area_code=209, + country="US", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_create( + fax_line_create_request=fax_line_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_create: %s\n" % e) diff --git a/examples/FaxLineCreateExample.rb b/examples/FaxLineCreateExample.rb new file mode 100644 index 000000000..5342e5c31 --- /dev/null +++ b/examples/FaxLineCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new +fax_line_create_request.area_code = 209 +fax_line_create_request.country = "US" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_create( + fax_line_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_create: #{e}" +end diff --git a/examples/FaxLineCreate.sh b/examples/FaxLineCreateExample.sh similarity index 100% rename from examples/FaxLineCreate.sh rename to examples/FaxLineCreateExample.sh diff --git a/examples/FaxLineCreateExample.ts b/examples/FaxLineCreateExample.ts new file mode 100644 index 000000000..b9398b2fa --- /dev/null +++ b/examples/FaxLineCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineCreateRequest = new models.FaxLineCreateRequest(); +faxLineCreateRequest.areaCode = 209; +faxLineCreateRequest.country = models.FaxLineCreateRequest.CountryEnum.Us; + +apiCaller.faxLineCreate( + faxLineCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineCreate:"); + console.log(error.body); +}); diff --git a/examples/FaxLineDelete.java b/examples/FaxLineDelete.java deleted file mode 100644 index 6b989d287..000000000 --- a/examples/FaxLineDelete.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineDeleteRequest() - .number("[FAX_NUMBER]"); - - try { - faxLineApi.faxLineDelete(data); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineDelete.js b/examples/FaxLineDelete.js deleted file mode 100644 index 1e8bdda7c..000000000 --- a/examples/FaxLineDelete.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", -}; - -const result = faxLineApi.faxLineDelete(data); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineDelete.php b/examples/FaxLineDelete.php deleted file mode 100644 index 8cc4ee01f..000000000 --- a/examples/FaxLineDelete.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineDeleteRequest(); -$data->setNumber("[FAX_NUMBER]"); - -try { - $faxLineApi->faxLineDelete($data); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineDelete.py b/examples/FaxLineDelete.py deleted file mode 100644 index 060303934..000000000 --- a/examples/FaxLineDelete.py +++ /dev/null @@ -1,20 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineDeleteRequest( - number="[FAX_NUMBER]", - ) - - try: - fax_line_api.fax_line_delete(data) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineDelete.rb b/examples/FaxLineDelete.rb deleted file mode 100644 index 001cf6275..000000000 --- a/examples/FaxLineDelete.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineDeleteRequest.new -data.number = "[FAX_NUMBER]" - -begin - fax_line_api.fax_line_delete(data) -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineDelete.ts b/examples/FaxLineDelete.ts deleted file mode 100644 index 14efef4dc..000000000 --- a/examples/FaxLineDelete.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineDeleteRequest = { - number: "[FAX_NUMBER]", -}; - -const result = faxLineApi.faxLineDelete(data); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineDeleteExample.cs b/examples/FaxLineDeleteExample.cs new file mode 100644 index 000000000..42faed216 --- /dev/null +++ b/examples/FaxLineDeleteExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineDeleteRequest = new FaxLineDeleteRequest( + number: "[FAX_NUMBER]" + ); + + try + { + new FaxLineApi(config).FaxLineDelete( + faxLineDeleteRequest: faxLineDeleteRequest + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineDeleteExample.java b/examples/FaxLineDeleteExample.java new file mode 100644 index 000000000..348833fba --- /dev/null +++ b/examples/FaxLineDeleteExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineDeleteExample.php b/examples/FaxLineDeleteExample.php new file mode 100644 index 000000000..080db2960 --- /dev/null +++ b/examples/FaxLineDeleteExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_delete_request = (new Dropbox\Sign\Model\FaxLineDeleteRequest()) + ->setNumber("[FAX_NUMBER]"); + +try { + (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineDelete( + fax_line_delete_request: $fax_line_delete_request, + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineDelete: {$e->getMessage()}"; +} diff --git a/examples/FaxLineDeleteExample.py b/examples/FaxLineDeleteExample.py new file mode 100644 index 000000000..e5e7c23ea --- /dev/null +++ b/examples/FaxLineDeleteExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_delete_request = models.FaxLineDeleteRequest( + number="[FAX_NUMBER]", + ) + + try: + api.FaxLineApi(api_client).fax_line_delete( + fax_line_delete_request=fax_line_delete_request, + ) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_delete: %s\n" % e) diff --git a/examples/FaxLineDeleteExample.rb b/examples/FaxLineDeleteExample.rb new file mode 100644 index 000000000..c54da52b1 --- /dev/null +++ b/examples/FaxLineDeleteExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new +fax_line_delete_request.number = "[FAX_NUMBER]" + +begin + Dropbox::Sign::FaxLineApi.new.fax_line_delete( + fax_line_delete_request, + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_delete: #{e}" +end diff --git a/examples/FaxLineDelete.sh b/examples/FaxLineDeleteExample.sh similarity index 100% rename from examples/FaxLineDelete.sh rename to examples/FaxLineDeleteExample.sh diff --git a/examples/FaxLineDeleteExample.ts b/examples/FaxLineDeleteExample.ts new file mode 100644 index 000000000..72b2279a3 --- /dev/null +++ b/examples/FaxLineDeleteExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineDeleteRequest = new models.FaxLineDeleteRequest(); +faxLineDeleteRequest.number = "[FAX_NUMBER]"; + +apiCaller.faxLineDelete( + faxLineDeleteRequest, +).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineDelete:"); + console.log(error.body); +}); diff --git a/examples/FaxLineGet.java b/examples/FaxLineGet.java deleted file mode 100644 index 69281b342..000000000 --- a/examples/FaxLineGet.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineResponse result = faxLineApi.faxLineGet("[FAX_NUMBER]"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineGet.js b/examples/FaxLineGet.js deleted file mode 100644 index e9643abe9..000000000 --- a/examples/FaxLineGet.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineGet("[FAX_NUMBER]"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineGet.php b/examples/FaxLineGet.php deleted file mode 100644 index 75dd77b5c..000000000 --- a/examples/FaxLineGet.php +++ /dev/null @@ -1,19 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineGet("[FAX_NUMBER]"); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineGet.rb b/examples/FaxLineGet.rb deleted file mode 100644 index 090c2bdd8..000000000 --- a/examples/FaxLineGet.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_get("[NUMBER]") - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineGet.ts b/examples/FaxLineGet.ts deleted file mode 100644 index e9643abe9..000000000 --- a/examples/FaxLineGet.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineGet("[FAX_NUMBER]"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineGetExample.cs b/examples/FaxLineGetExample.cs new file mode 100644 index 000000000..690a65360 --- /dev/null +++ b/examples/FaxLineGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineGet( + number: "123-123-1234" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineGetExample.java b/examples/FaxLineGetExample.java new file mode 100644 index 000000000..8f9cd3169 --- /dev/null +++ b/examples/FaxLineGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineGetExample.php b/examples/FaxLineGetExample.php new file mode 100644 index 000000000..70004942a --- /dev/null +++ b/examples/FaxLineGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineGet( + number: "123-123-1234", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineGet: {$e->getMessage()}"; +} diff --git a/examples/FaxLineGetExample.py b/examples/FaxLineGetExample.py new file mode 100644 index 000000000..56d2a204d --- /dev/null +++ b/examples/FaxLineGetExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_get( + number="123-123-1234", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_get: %s\n" % e) diff --git a/examples/FaxLineGetExample.rb b/examples/FaxLineGetExample.rb new file mode 100644 index 000000000..d4a749bd8 --- /dev/null +++ b/examples/FaxLineGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_get( + "123-123-1234", # number + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_get: #{e}" +end diff --git a/examples/FaxLineGet.sh b/examples/FaxLineGetExample.sh similarity index 100% rename from examples/FaxLineGet.sh rename to examples/FaxLineGetExample.sh diff --git a/examples/FaxLineGetExample.ts b/examples/FaxLineGetExample.ts new file mode 100644 index 000000000..e5ee2fd0f --- /dev/null +++ b/examples/FaxLineGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineGet( + "123-123-1234", // number +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineGet:"); + console.log(error.body); +}); diff --git a/examples/FaxLineList.java b/examples/FaxLineList.java deleted file mode 100644 index df1d0bd13..000000000 --- a/examples/FaxLineList.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineListResponse result = faxLineApi.faxLineList(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineList.js b/examples/FaxLineList.js deleted file mode 100644 index f40c60dfa..000000000 --- a/examples/FaxLineList.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineList(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineList.php b/examples/FaxLineList.php deleted file mode 100644 index 6056a2427..000000000 --- a/examples/FaxLineList.php +++ /dev/null @@ -1,19 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineList(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineList.rb b/examples/FaxLineList.rb deleted file mode 100644 index 23a0ec845..000000000 --- a/examples/FaxLineList.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_list() - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineList.ts b/examples/FaxLineList.ts deleted file mode 100644 index f40c60dfa..000000000 --- a/examples/FaxLineList.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineList(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineListExample.cs b/examples/FaxLineListExample.cs new file mode 100644 index 000000000..cbd75903e --- /dev/null +++ b/examples/FaxLineListExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineList( + accountId: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + pageSize: 20, + showTeamLines: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineListExample.java b/examples/FaxLineListExample.java new file mode 100644 index 000000000..7ce8cf1cf --- /dev/null +++ b/examples/FaxLineListExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineListExample.php b/examples/FaxLineListExample.php new file mode 100644 index 000000000..995c0d949 --- /dev/null +++ b/examples/FaxLineListExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineList( + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineList: {$e->getMessage()}"; +} diff --git a/examples/FaxLineListExample.py b/examples/FaxLineListExample.py new file mode 100644 index 000000000..4af3f4a56 --- /dev/null +++ b/examples/FaxLineListExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_list( + account_id="ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page=1, + page_size=20, + show_team_lines=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) diff --git a/examples/FaxLineListExample.rb b/examples/FaxLineListExample.rb new file mode 100644 index 000000000..0da5a39e4 --- /dev/null +++ b/examples/FaxLineListExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_list( + { + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_list: #{e}" +end diff --git a/examples/FaxLineList.sh b/examples/FaxLineListExample.sh similarity index 100% rename from examples/FaxLineList.sh rename to examples/FaxLineListExample.sh diff --git a/examples/FaxLineListExample.ts b/examples/FaxLineListExample.ts new file mode 100644 index 000000000..aa547afce --- /dev/null +++ b/examples/FaxLineListExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + undefined, // showTeamLines +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineList:"); + console.log(error.body); +}); diff --git a/examples/FaxLineRemoveUser.java b/examples/FaxLineRemoveUser.java deleted file mode 100644 index 7864b05ab..000000000 --- a/examples/FaxLineRemoveUser.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineRemoveUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineRemoveUser(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineRemoveUser.js b/examples/FaxLineRemoveUser.js deleted file mode 100644 index 64f247924..000000000 --- a/examples/FaxLineRemoveUser.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineRemoveUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineRemoveUser.php b/examples/FaxLineRemoveUser.php deleted file mode 100644 index 60132fedc..000000000 --- a/examples/FaxLineRemoveUser.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineRemoveUserRequest(); -$data->setNumber("[FAX_NUMBER]") - ->setEmailAddress("member@dropboxsign.com"); - -try { - $result = $faxLineApi->faxLineRemoveUser($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineRemoveUser.rb b/examples/FaxLineRemoveUser.rb deleted file mode 100644 index 98bb7a047..000000000 --- a/examples/FaxLineRemoveUser.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineRemoveUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" - -begin - result = fax_line_api.fax_line_remove_user(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineRemoveUser.ts b/examples/FaxLineRemoveUser.ts deleted file mode 100644 index 91dc3066b..000000000 --- a/examples/FaxLineRemoveUser.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineRemoveUserRequest = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineRemoveUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineRemoveUserExample.cs b/examples/FaxLineRemoveUserExample.cs new file mode 100644 index 000000000..809b89a4e --- /dev/null +++ b/examples/FaxLineRemoveUserExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest( + number: "[FAX_NUMBER]", + emailAddress: "member@dropboxsign.com" + ); + + try + { + var response = new FaxLineApi(config).FaxLineRemoveUser( + faxLineRemoveUserRequest: faxLineRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineRemoveUserExample.java b/examples/FaxLineRemoveUserExample.java new file mode 100644 index 000000000..568d08d5d --- /dev/null +++ b/examples/FaxLineRemoveUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineRemoveUserExample.php b/examples/FaxLineRemoveUserExample.php new file mode 100644 index 000000000..95d117971 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_remove_user_request = (new Dropbox\Sign\Model\FaxLineRemoveUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineRemoveUser( + fax_line_remove_user_request: $fax_line_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineRemoveUser: {$e->getMessage()}"; +} diff --git a/examples/FaxLineRemoveUserExample.py b/examples/FaxLineRemoveUserExample.py new file mode 100644 index 000000000..366957bac --- /dev/null +++ b/examples/FaxLineRemoveUserExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_remove_user_request = models.FaxLineRemoveUserRequest( + number="[FAX_NUMBER]", + email_address="member@dropboxsign.com", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_remove_user( + fax_line_remove_user_request=fax_line_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_remove_user: %s\n" % e) diff --git a/examples/FaxLineRemoveUserExample.rb b/examples/FaxLineRemoveUserExample.rb new file mode 100644 index 000000000..4f67f7e11 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new +fax_line_remove_user_request.number = "[FAX_NUMBER]" +fax_line_remove_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user( + fax_line_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}" +end diff --git a/examples/FaxLineRemoveUser.sh b/examples/FaxLineRemoveUserExample.sh similarity index 100% rename from examples/FaxLineRemoveUser.sh rename to examples/FaxLineRemoveUserExample.sh diff --git a/examples/FaxLineRemoveUserExample.ts b/examples/FaxLineRemoveUserExample.ts new file mode 100644 index 000000000..e73b8c7c5 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineRemoveUserRequest = new models.FaxLineRemoveUserRequest(); +faxLineRemoveUserRequest.number = "[FAX_NUMBER]"; +faxLineRemoveUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineRemoveUser( + faxLineRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineRemoveUser:"); + console.log(error.body); +}); diff --git a/examples/FaxList.cs b/examples/FaxList.cs deleted file mode 100644 index f87d9b8f2..000000000 --- a/examples/FaxList.cs +++ /dev/null @@ -1,32 +0,0 @@ -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/FaxList.java b/examples/FaxList.java deleted file mode 100644 index 042bb7107..000000000 --- a/examples/FaxList.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - FaxListResponse result = faxApi.faxList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxList.js b/examples/FaxList.js deleted file mode 100644 index 385f44779..000000000 --- a/examples/FaxList.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const page = 1; -const pageSize = 2; - -const result = faxApi.faxList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxList.php b/examples/FaxList.php deleted file mode 100644 index d2a513c21..000000000 --- a/examples/FaxList.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$page = 1; -$pageSize = 2; - -try { - $result = $faxApi->faxList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxList.py b/examples/FaxList.py deleted file mode 100644 index 6b71f79b6..000000000 --- a/examples/FaxList.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - page = 1 - page_size = 2 - - try: - response = fax_api.fax_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxList.rb b/examples/FaxList.rb deleted file mode 100644 index 3f37a71ea..000000000 --- a/examples/FaxList.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -page = 1 -page_size = 2 - -begin - result = fax_api.fax_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxList.ts b/examples/FaxList.ts deleted file mode 100644 index 385f44779..000000000 --- a/examples/FaxList.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const page = 1; -const pageSize = 2; - -const result = faxApi.faxList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxListExample.cs b/examples/FaxListExample.cs new file mode 100644 index 000000000..64450619d --- /dev/null +++ b/examples/FaxListExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxListExample.java b/examples/FaxListExample.java new file mode 100644 index 000000000..1ca7c0a54 --- /dev/null +++ b/examples/FaxListExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxListExample.php b/examples/FaxListExample.php new file mode 100644 index 000000000..c0d432351 --- /dev/null +++ b/examples/FaxListExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxList: {$e->getMessage()}"; +} diff --git a/examples/FaxLineGet.py b/examples/FaxListExample.py similarity index 52% rename from examples/FaxLineGet.py rename to examples/FaxListExample.py index f550474fa..44f840a7f 100644 --- a/examples/FaxLineGet.py +++ b/examples/FaxListExample.py @@ -1,17 +1,20 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_get("[FAX_NUMBER]") + response = api.FaxApi(api_client).fax_list( + page=1, + page_size=20, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_list: %s\n" % e) diff --git a/examples/FaxListExample.rb b/examples/FaxListExample.rb new file mode 100644 index 000000000..519e04dad --- /dev/null +++ b/examples/FaxListExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_list: #{e}" +end diff --git a/examples/FaxList.sh b/examples/FaxListExample.sh similarity index 100% rename from examples/FaxList.sh rename to examples/FaxListExample.sh diff --git a/examples/FaxListExample.ts b/examples/FaxListExample.ts new file mode 100644 index 000000000..70b904d6f --- /dev/null +++ b/examples/FaxListExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxList:"); + console.log(error.body); +}); diff --git a/examples/FaxSend.java b/examples/FaxSend.java deleted file mode 100644 index 4e764da83..000000000 --- a/examples/FaxSend.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - - var data = new FaxSendRequest() - .addFilesItem(new File("example_fax.pdf")) - .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 { - FaxCreateResponse result = faxApi.faxSend(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxSend.js b/examples/FaxSend.js deleted file mode 100644 index 4b0eef2da..000000000 --- a/examples/FaxSend.js +++ /dev/null @@ -1,47 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data = { - files: [ file, fileBuffer, fileBufferAlt ], - 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!", -}; - -const result = faxApi.faxSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxSend.php b/examples/FaxSend.php deleted file mode 100644 index 2dd42d386..000000000 --- a/examples/FaxSend.php +++ /dev/null @@ -1,29 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$data = new Dropbox\Sign\Model\FaxSendRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTestMode(true) - ->setRecipient("16690000001") - ->setSender("16690000000") - ->setCoverPageTo("Jill Fax") - ->setCoverPageMessage("I'm sending you a fax!") - ->setCoverPageFrom("Faxer Faxerson") - ->setTitle("This is what the fax is about!"); - -try { - $result = $faxApi->faxSend($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxSend.rb b/examples/FaxSend.rb deleted file mode 100644 index c37cbbd10..000000000 --- a/examples/FaxSend.rb +++ /dev/null @@ -1,25 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -data = Dropbox::Sign::FaxSendRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] -data.test_mode = true -data.recipient = "16690000001" -data.sender = "16690000000" -data.cover_page_to = "Jill Fax" -data.cover_page_message = "I'm sending you a fax!" -data.cover_page_from = "Faxer Faxerson" -data.title = "This is what the fax is about!" - -begin - result = fax_api.fax_send(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxSend.ts b/examples/FaxSend.ts deleted file mode 100644 index 2f3f6e25d..000000000 --- a/examples/FaxSend.ts +++ /dev/null @@ -1,47 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.FaxSendRequest = { - files: [ file, fileBuffer, fileBufferAlt ], - 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!", -}; - -const result = faxApi.faxSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxSend.cs b/examples/FaxSendExample.cs similarity index 54% rename from examples/FaxSend.cs rename to examples/FaxSendExample.cs index 8e72a4f93..e6a2270be 100644 --- a/examples/FaxSend.cs +++ b/examples/FaxSendExample.cs @@ -1,47 +1,49 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxSendExample { - public static void Main() + public static void Run() { 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, + var faxSendRequest = new FaxSendRequest( recipient: "16690000001", sender: "16690000000", + testMode: true, coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", coverPageFrom: "Faxer Faxerson", + coverPageMessage: "I'm sending you a fax!", title: "This is what the fax is about!", + files: new List + { + new FileStream( + path: "./example_fax.pdf", + mode: FileMode.Open + ), + } ); try { - var result = faxApi.FaxSend(data); - Console.WriteLine(result); + var response = new FaxApi(config).FaxSend( + faxSendRequest: faxSendRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxSend: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/FaxSendExample.java b/examples/FaxSendExample.java new file mode 100644 index 000000000..62696b80d --- /dev/null +++ b/examples/FaxSendExample.java @@ -0,0 +1,51 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxSendExample.php b/examples/FaxSendExample.php new file mode 100644 index 000000000..707e8ce25 --- /dev/null +++ b/examples/FaxSendExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); + +$fax_send_request = (new Dropbox\Sign\Model\FaxSendRequest()) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setTestMode(true) + ->setCoverPageTo("Jill Fax") + ->setCoverPageFrom("Faxer Faxerson") + ->setCoverPageMessage("I'm sending you a fax!") + ->setTitle("This is what the fax is about!") + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxSend( + fax_send_request: $fax_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxSend: {$e->getMessage()}"; +} diff --git a/examples/FaxSend.py b/examples/FaxSendExample.py similarity index 59% rename from examples/FaxSend.py rename to examples/FaxSendExample.py index c24d6ada7..77fbf8bbf 100644 --- a/examples/FaxSend.py +++ b/examples/FaxSendExample.py @@ -1,28 +1,32 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - data = models.FaxSendRequest( - files=[open("example_signature_request.pdf", "rb")], - test_mode=True, + fax_send_request = models.FaxSendRequest( recipient="16690000001", sender="16690000000", + test_mode=True, cover_page_to="Jill Fax", - cover_page_message="I'm sending you a fax!", cover_page_from="Faxer Faxerson", + cover_page_message="I'm sending you a fax!", title="This is what the fax is about!", + files=[ + open("./example_fax.pdf", "rb").read(), + ], ) try: - response = fax_api.fax_send(data) + response = api.FaxApi(api_client).fax_send( + fax_send_request=fax_send_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_send: %s\n" % e) diff --git a/examples/FaxSendExample.rb b/examples/FaxSendExample.rb new file mode 100644 index 000000000..4faeaa725 --- /dev/null +++ b/examples/FaxSendExample.rb @@ -0,0 +1,28 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_send_request = Dropbox::Sign::FaxSendRequest.new +fax_send_request.recipient = "16690000001" +fax_send_request.sender = "16690000000" +fax_send_request.test_mode = true +fax_send_request.cover_page_to = "Jill Fax" +fax_send_request.cover_page_from = "Faxer Faxerson" +fax_send_request.cover_page_message = "I'm sending you a fax!" +fax_send_request.title = "This is what the fax is about!" +fax_send_request.files = [ + File.new("./example_fax.pdf", "r"), +] + +begin + response = Dropbox::Sign::FaxApi.new.fax_send( + fax_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_send: #{e}" +end diff --git a/examples/FaxSend.sh b/examples/FaxSendExample.sh similarity index 100% rename from examples/FaxSend.sh rename to examples/FaxSendExample.sh diff --git a/examples/FaxSendExample.ts b/examples/FaxSendExample.ts new file mode 100644 index 000000000..0b39faee5 --- /dev/null +++ b/examples/FaxSendExample.ts @@ -0,0 +1,27 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxSendRequest = new models.FaxSendRequest(); +faxSendRequest.recipient = "16690000001"; +faxSendRequest.sender = "16690000000"; +faxSendRequest.testMode = true; +faxSendRequest.coverPageTo = "Jill Fax"; +faxSendRequest.coverPageFrom = "Faxer Faxerson"; +faxSendRequest.coverPageMessage = "I'm sending you a fax!"; +faxSendRequest.title = "This is what the fax is about!"; +faxSendRequest.files = [ + fs.createReadStream("./example_fax.pdf"), +]; + +apiCaller.faxSend( + faxSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxSend:"); + console.log(error.body); +}); diff --git a/examples/OauthTokenGenerate.cs b/examples/OauthTokenGenerate.cs deleted file mode 100644 index f76153ba4..000000000 --- a/examples/OauthTokenGenerate.cs +++ /dev/null @@ -1,35 +0,0 @@ -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(); - - var oAuthApi = new OAuthApi(config); - - var data = new OAuthTokenGenerateRequest( - state: "900e06e2", - code: "1b0d28d90c86c141", - clientId: "cc91c61d00f8bb2ece1428035716b", - clientSecret: "1d14434088507ffa390e6f5528465" - ); - - try - { - var result = oAuthApi.OauthTokenGenerate(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/examples/OauthTokenGenerate.java b/examples/OauthTokenGenerate.java deleted file mode 100644 index b8a5ebf30..000000000 --- a/examples/OauthTokenGenerate.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenGenerateRequest() - .state("900e06e2") - .code("1b0d28d90c86c141") - .clientId("cc91c61d00f8bb2ece1428035716b") - .clientSecret("1d14434088507ffa390e6f5528465"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenGenerate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/OauthTokenGenerate.js b/examples/OauthTokenGenerate.js deleted file mode 100644 index 20a34133c..000000000 --- a/examples/OauthTokenGenerate.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenGenerateRequest(); -data.state = "900e06e2"; -data.code = "1b0d28d90c86c141"; -data.clientId = "cc91c61d00f8bb2ece1428035716b"; -data.clientSecret = "1d14434088507ffa390e6f5528465"; - -const result = oAuthApi.oauthTokenGenerate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenGenerate.php b/examples/OauthTokenGenerate.php deleted file mode 100644 index d90201e92..000000000 --- a/examples/OauthTokenGenerate.php +++ /dev/null @@ -1,22 +0,0 @@ -setState("900e06e2") - ->setCode("1b0d28d90c86c141") - ->setClientId("cc91c61d00f8bb2ece1428035716b") - ->setClientSecret("1d14434088507ffa390e6f5528465"); - -try { - $result = $oauthApi->oauthTokenGenerate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/OauthTokenGenerate.py b/examples/OauthTokenGenerate.py deleted file mode 100644 index abe76c7e0..000000000 --- a/examples/OauthTokenGenerate.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration() - -with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenGenerateRequest( - state="900e06e2", - code="1b0d28d90c86c141", - client_id="cc91c61d00f8bb2ece1428035716b", - client_secret="1d14434088507ffa390e6f5528465", - ) - - try: - response = oauth_api.oauth_token_generate(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/OauthTokenGenerate.rb b/examples/OauthTokenGenerate.rb deleted file mode 100644 index b5b38c8fe..000000000 --- a/examples/OauthTokenGenerate.rb +++ /dev/null @@ -1,16 +0,0 @@ -require "dropbox-sign" - -oauth_api = Dropbox::Sign::OAuthApi.new - -data = Dropbox::Sign::OAuthTokenGenerateRequest.new -data.state = "900e06e2" -data.code = "1b0d28d90c86c141" -data.client_id = "cc91c61d00f8bb2ece1428035716b" -data.client_secret = "1d14434088507ffa390e6f5528465" - -begin - result = oauth_api.oauth_token_generate(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/OauthTokenGenerate.ts b/examples/OauthTokenGenerate.ts deleted file mode 100644 index 20a34133c..000000000 --- a/examples/OauthTokenGenerate.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenGenerateRequest(); -data.state = "900e06e2"; -data.code = "1b0d28d90c86c141"; -data.clientId = "cc91c61d00f8bb2ece1428035716b"; -data.clientSecret = "1d14434088507ffa390e6f5528465"; - -const result = oAuthApi.oauthTokenGenerate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenGenerateExample.cs b/examples/OauthTokenGenerateExample.cs new file mode 100644 index 000000000..7d8da2fca --- /dev/null +++ b/examples/OauthTokenGenerateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenGenerateExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest( + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465", + code: "1b0d28d90c86c141", + state: "900e06e2", + grantType: "authorization_code" + ); + + try + { + var response = new OAuthApi(config).OauthTokenGenerate( + oAuthTokenGenerateRequest: oAuthTokenGenerateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenGenerate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/OauthTokenGenerateExample.java b/examples/OauthTokenGenerateExample.java new file mode 100644 index 000000000..7c51af01f --- /dev/null +++ b/examples/OauthTokenGenerateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenGenerate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/OauthTokenGenerateExample.php b/examples/OauthTokenGenerateExample.php new file mode 100644 index 000000000..9b2df4a08 --- /dev/null +++ b/examples/OauthTokenGenerateExample.php @@ -0,0 +1,27 @@ +setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465") + ->setCode("1b0d28d90c86c141") + ->setState("900e06e2") + ->setGrantType("authorization_code"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenGenerate( + o_auth_token_generate_request: $o_auth_token_generate_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenGenerate: {$e->getMessage()}"; +} diff --git a/examples/OauthTokenGenerateExample.py b/examples/OauthTokenGenerateExample.py new file mode 100644 index 000000000..69cec3ffd --- /dev/null +++ b/examples/OauthTokenGenerateExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( +) + +with ApiClient(configuration) as api_client: + o_auth_token_generate_request = models.OAuthTokenGenerateRequest( + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + code="1b0d28d90c86c141", + state="900e06e2", + grant_type="authorization_code", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_generate( + o_auth_token_generate_request=o_auth_token_generate_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_generate: %s\n" % e) diff --git a/examples/OauthTokenGenerateExample.rb b/examples/OauthTokenGenerateExample.rb new file mode 100644 index 000000000..47553822e --- /dev/null +++ b/examples/OauthTokenGenerateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new +o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b" +o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465" +o_auth_token_generate_request.code = "1b0d28d90c86c141" +o_auth_token_generate_request.state = "900e06e2" +o_auth_token_generate_request.grant_type = "authorization_code" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_generate( + o_auth_token_generate_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_generate: #{e}" +end diff --git a/examples/OauthTokenGenerate.sh b/examples/OauthTokenGenerateExample.sh similarity index 100% rename from examples/OauthTokenGenerate.sh rename to examples/OauthTokenGenerateExample.sh diff --git a/examples/OauthTokenGenerateExample.ts b/examples/OauthTokenGenerateExample.ts new file mode 100644 index 000000000..ace0df01d --- /dev/null +++ b/examples/OauthTokenGenerateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenGenerateRequest = new models.OAuthTokenGenerateRequest(); +oAuthTokenGenerateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +oAuthTokenGenerateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; +oAuthTokenGenerateRequest.code = "1b0d28d90c86c141"; +oAuthTokenGenerateRequest.state = "900e06e2"; +oAuthTokenGenerateRequest.grantType = "authorization_code"; + +apiCaller.oauthTokenGenerate( + oAuthTokenGenerateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenGenerate:"); + console.log(error.body); +}); diff --git a/examples/OauthTokenRefresh.cs b/examples/OauthTokenRefresh.cs deleted file mode 100644 index 41f3235ee..000000000 --- a/examples/OauthTokenRefresh.cs +++ /dev/null @@ -1,32 +0,0 @@ -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(); - - var oAuthApi = new OAuthApi(config); - - var data = new OAuthTokenRefreshRequest( - refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" - ); - - try - { - var result = oAuthApi.OauthTokenRefresh(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/examples/OauthTokenRefresh.java b/examples/OauthTokenRefresh.java deleted file mode 100644 index 8add0c186..000000000 --- a/examples/OauthTokenRefresh.java +++ /dev/null @@ -1,27 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenRefreshRequest() - .refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenRefresh(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/OauthTokenRefresh.js b/examples/OauthTokenRefresh.js deleted file mode 100644 index da46f9f1e..000000000 --- a/examples/OauthTokenRefresh.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenRefreshRequest(); -data.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; - -const result = oAuthApi.oauthTokenRefresh(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenRefresh.php b/examples/OauthTokenRefresh.php deleted file mode 100644 index ad3e7ad26..000000000 --- a/examples/OauthTokenRefresh.php +++ /dev/null @@ -1,19 +0,0 @@ -setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - -try { - $result = $oauthApi->oauthTokenRefresh($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/OauthTokenRefresh.py b/examples/OauthTokenRefresh.py deleted file mode 100644 index fb6d5e36d..000000000 --- a/examples/OauthTokenRefresh.py +++ /dev/null @@ -1,18 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration() - -with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenRefreshRequest( - refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", - ) - - try: - response = oauth_api.oauth_token_refresh(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/OauthTokenRefresh.rb b/examples/OauthTokenRefresh.rb deleted file mode 100644 index bac7eb63c..000000000 --- a/examples/OauthTokenRefresh.rb +++ /dev/null @@ -1,13 +0,0 @@ -require "dropbox-sign" - -oauth_api = Dropbox::Sign::OAuthApi.new - -data = Dropbox::Sign::OAuthTokenRefreshRequest.new -data.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" - -begin - result = oauth_api.oauth_token_refresh(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/OauthTokenRefresh.ts b/examples/OauthTokenRefresh.ts deleted file mode 100644 index da46f9f1e..000000000 --- a/examples/OauthTokenRefresh.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenRefreshRequest(); -data.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; - -const result = oAuthApi.oauthTokenRefresh(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenRefreshExample.cs b/examples/OauthTokenRefreshExample.cs new file mode 100644 index 000000000..21c40d14c --- /dev/null +++ b/examples/OauthTokenRefreshExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenRefreshExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest( + grantType: "refresh_token", + refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + ); + + try + { + var response = new OAuthApi(config).OauthTokenRefresh( + oAuthTokenRefreshRequest: oAuthTokenRefreshRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenRefresh: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/OauthTokenRefreshExample.java b/examples/OauthTokenRefreshExample.java new file mode 100644 index 000000000..5b2133b0e --- /dev/null +++ b/examples/OauthTokenRefreshExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenRefresh"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/OauthTokenRefreshExample.php b/examples/OauthTokenRefreshExample.php new file mode 100644 index 000000000..519db72d1 --- /dev/null +++ b/examples/OauthTokenRefreshExample.php @@ -0,0 +1,24 @@ +setGrantType("refresh_token") + ->setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenRefresh( + o_auth_token_refresh_request: $o_auth_token_refresh_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenRefresh: {$e->getMessage()}"; +} diff --git a/examples/OauthTokenRefreshExample.py b/examples/OauthTokenRefreshExample.py new file mode 100644 index 000000000..7bd30fbf8 --- /dev/null +++ b/examples/OauthTokenRefreshExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( +) + +with ApiClient(configuration) as api_client: + o_auth_token_refresh_request = models.OAuthTokenRefreshRequest( + grant_type="refresh_token", + refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_refresh( + o_auth_token_refresh_request=o_auth_token_refresh_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_refresh: %s\n" % e) diff --git a/examples/OauthTokenRefreshExample.rb b/examples/OauthTokenRefreshExample.rb new file mode 100644 index 000000000..5068b44da --- /dev/null +++ b/examples/OauthTokenRefreshExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new +o_auth_token_refresh_request.grant_type = "refresh_token" +o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh( + o_auth_token_refresh_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}" +end diff --git a/examples/OauthTokenRefresh.sh b/examples/OauthTokenRefreshExample.sh similarity index 100% rename from examples/OauthTokenRefresh.sh rename to examples/OauthTokenRefreshExample.sh diff --git a/examples/OauthTokenRefreshExample.ts b/examples/OauthTokenRefreshExample.ts new file mode 100644 index 000000000..fa9973e6f --- /dev/null +++ b/examples/OauthTokenRefreshExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenRefreshRequest = new models.OAuthTokenRefreshRequest(); +oAuthTokenRefreshRequest.grantType = "refresh_token"; +oAuthTokenRefreshRequest.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; + +apiCaller.oauthTokenRefresh( + oAuthTokenRefreshRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenRefresh:"); + console.log(error.body); +}); diff --git a/examples/ReportCreate.java b/examples/ReportCreate.java deleted file mode 100644 index 038f03b9f..000000000 --- a/examples/ReportCreate.java +++ /dev/null @@ -1,41 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var reportApi = new ReportApi(apiClient); - - var data = new ReportCreateRequest() - .startDate("09/01/2020") - .endDate("09/01/2020") - .reportType(List.of( - ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, - ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS - )); - - try { - ReportCreateResponse result = reportApi.reportCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ReportCreate.js b/examples/ReportCreate.js deleted file mode 100644 index 738b12ac3..000000000 --- a/examples/ReportCreate.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const reportApi = new DropboxSign.ReportApi(); - -// Configure HTTP basic authorization: api_key -reportApi.username = "YOUR_API_KEY"; - -const data = { - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: [ - "user_activity", - "document_status", - ] -}; - -const result = reportApi.reportCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ReportCreate.php b/examples/ReportCreate.php deleted file mode 100644 index 1f030f6e5..000000000 --- a/examples/ReportCreate.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$reportApi = new Dropbox\Sign\Api\ReportApi($config); - -$data = new Dropbox\Sign\Model\ReportCreateRequest(); -$data->setStartDate("09/01/2020") - ->setEndDate("09/01/2020") - ->setReportType([ - Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, - Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, - ]); - -try { - $result = $reportApi->reportCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ReportCreate.py b/examples/ReportCreate.py deleted file mode 100644 index e736c4a77..000000000 --- a/examples/ReportCreate.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - report_api = apis.ReportApi(api_client) - - data = models.ReportCreateRequest( - start_date="09/01/2020", - end_date="09/01/2020", - report_type=["user_activity" "document_status"], - ) - - try: - response = report_api.report_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ReportCreate.rb b/examples/ReportCreate.rb deleted file mode 100644 index 71da9d1f6..000000000 --- a/examples/ReportCreate.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -report_api = Dropbox::Sign::ReportApi.new - -data = Dropbox::Sign::ReportCreateRequest.new -data.start_date = "09/01/2020" -data.end_date = "09/01/2020" -data.report_type = %w[user_activity document_status] - -begin - result = report_api.report_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ReportCreate.ts b/examples/ReportCreate.ts deleted file mode 100644 index 39da03ca6..000000000 --- a/examples/ReportCreate.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const reportApi = new DropboxSign.ReportApi(); - -// Configure HTTP basic authorization: api_key -reportApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.ReportCreateRequest = { - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: [ - DropboxSign.ReportCreateRequest.ReportTypeEnum.UserActivity, - DropboxSign.ReportCreateRequest.ReportTypeEnum.DocumentStatus, - ] -}; - -const result = reportApi.reportCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ReportCreate.cs b/examples/ReportCreateExample.cs similarity index 53% rename from examples/ReportCreate.cs rename to examples/ReportCreateExample.cs index 994169a54..769bd3a18 100644 --- a/examples/ReportCreate.cs +++ b/examples/ReportCreateExample.cs @@ -1,40 +1,41 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ReportCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var reportApi = new ReportApi(config); - - var data = new ReportCreateRequest( + var reportCreateRequest = new ReportCreateRequest( startDate: "09/01/2020", endDate: "09/01/2020", - reportType: new List() { + reportType: [ ReportCreateRequest.ReportTypeEnum.UserActivity, ReportCreateRequest.ReportTypeEnum.DocumentStatus, - } + ] ); try { - var result = reportApi.OauthCreate(data); - Console.WriteLine(result); + var response = new ReportApi(config).ReportCreate( + reportCreateRequest: reportCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ReportApi#ReportCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/ReportCreateExample.java b/examples/ReportCreateExample.java new file mode 100644 index 000000000..ecd726bcb --- /dev/null +++ b/examples/ReportCreateExample.java @@ -0,0 +1,47 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ReportApi#reportCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ReportCreateExample.php b/examples/ReportCreateExample.php new file mode 100644 index 000000000..18d8d09ea --- /dev/null +++ b/examples/ReportCreateExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); + +$report_create_request = (new Dropbox\Sign\Model\ReportCreateRequest()) + ->setStartDate("09/01/2020") + ->setEndDate("09/01/2020") + ->setReportType([ + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, + ]); + +try { + $response = (new Dropbox\Sign\Api\ReportApi(config: $config))->reportCreate( + report_create_request: $report_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ReportApi#reportCreate: {$e->getMessage()}"; +} diff --git a/examples/ReportCreateExample.py b/examples/ReportCreateExample.py new file mode 100644 index 000000000..cfcc85d84 --- /dev/null +++ b/examples/ReportCreateExample.py @@ -0,0 +1,28 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + report_create_request = models.ReportCreateRequest( + start_date="09/01/2020", + end_date="09/01/2020", + report_type=[ + "user_activity", + "document_status", + ], + ) + + try: + response = api.ReportApi(api_client).report_create( + report_create_request=report_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ReportApi#report_create: %s\n" % e) diff --git a/examples/ReportCreateExample.rb b/examples/ReportCreateExample.rb new file mode 100644 index 000000000..d5169ca61 --- /dev/null +++ b/examples/ReportCreateExample.rb @@ -0,0 +1,24 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +report_create_request = Dropbox::Sign::ReportCreateRequest.new +report_create_request.start_date = "09/01/2020" +report_create_request.end_date = "09/01/2020" +report_create_request.report_type = [ + "user_activity", + "document_status", +] + +begin + response = Dropbox::Sign::ReportApi.new.report_create( + report_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ReportApi#report_create: #{e}" +end diff --git a/examples/ReportCreate.sh b/examples/ReportCreateExample.sh similarity index 100% rename from examples/ReportCreate.sh rename to examples/ReportCreateExample.sh diff --git a/examples/ReportCreateExample.ts b/examples/ReportCreateExample.ts new file mode 100644 index 000000000..57bf8127d --- /dev/null +++ b/examples/ReportCreateExample.ts @@ -0,0 +1,23 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ReportApi(); +apiCaller.username = "YOUR_API_KEY"; + +const reportCreateRequest = new models.ReportCreateRequest(); +reportCreateRequest.startDate = "09/01/2020"; +reportCreateRequest.endDate = "09/01/2020"; +reportCreateRequest.reportType = [ + models.ReportCreateRequest.ReportTypeEnum.UserActivity, + models.ReportCreateRequest.ReportTypeEnum.DocumentStatus, +]; + +apiCaller.reportCreate( + reportCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ReportApi#reportCreate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs deleted file mode 100644 index d87fd12fb..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs +++ /dev/null @@ -1,82 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signerList1Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td" - ); - - var signerList1CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "ABC Corp" - ); - - var signerList1 = new SubBulkSignerList( - signers: new List(){signerList1Signer}, - customFields: new List(){signerList1CustomFields} - ); - - var signerList2Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b" - ); - - var signerList2CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "123 Corp" - ); - - var signerList2 = new SubBulkSignerList( - signers: new List(){signerList2Signer}, - customFields: new List(){signerList2CustomFields} - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: new List(){signerList1, signerList2}, - ccs: new List(){cc1}, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestBulkCreateEmbeddedWithTemplate(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/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java deleted file mode 100644 index babaca310..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,73 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC().role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js deleted file mode 100644 index 6a303bafd..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js +++ /dev/null @@ -1,66 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields = { - name: "company", - value: "ABC Corp", -}; - -const signerList1 = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields = { - name: "company", - value: "123 LLC", -}; - -const signerList2 = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data = { - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php deleted file mode 100644 index 6c3de5c16..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php +++ /dev/null @@ -1,60 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com") - ->setPin("d79a3td"); - -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); - -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); - -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$data = new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); -$data->setClientId("1a659d9ad95bccd307ecad78d72192f8") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestBulkCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py deleted file mode 100644 index 71bcd0bb5..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,72 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", - ) - - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="ABC Corp", - ) - - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) - - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", - ) - - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", - ) - - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - client_id="1a659d9ad95bccd307ecad78d72192f8", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = ( - signature_request_api.signature_request_bulk_create_embedded_with_template( - data - ) - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb deleted file mode 100644 index e20babf4c..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,59 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" - -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" - -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] - -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" - -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" - -signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new -data.client_id = "1a659d9ad95bccd307ecad78d72192f8" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = signature_request_api.signature_request_bulk_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts deleted file mode 100644 index acb3aa5ae..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts +++ /dev/null @@ -1,63 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -const signerList1Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "ABC Corp", -}; - -const signerList1: DropboxSign.SubBulkSignerList = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "123 LLC", -}; - -const signerList2: DropboxSign.SubBulkSignerList = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data: DropboxSign.SignatureRequestBulkCreateEmbeddedWithTemplateRequest = { - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..9fd344a94 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + clientId: "1a659d9ad95bccd307ecad78d72192f8", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest: signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..fcfbef591 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..1727df311 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest()) + ->setClientId("1a659d9ad95bccd307ecad78d72192f8") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkCreateEmbeddedWithTemplate( + signature_request_bulk_create_embedded_with_template_request: $signature_request_bulk_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..b2cb98a38 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_create_embedded_with_template_request = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + client_id="1a659d9ad95bccd307ecad78d72192f8", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request=signature_request_bulk_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: %s\n" % e) diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..e01b04f47 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new +signature_request_bulk_create_embedded_with_template_request.client_id = "1a659d9ad95bccd307ecad78d72192f8" +signature_request_bulk_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_bulk_create_embedded_with_template_request.test_mode = true +signature_request_bulk_create_embedded_with_template_request.signer_list = signer_list +signature_request_bulk_create_embedded_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh rename to examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..d8b5b2ef9 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkCreateEmbeddedWithTemplateRequest = new models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); +signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId = "1a659d9ad95bccd307ecad78d72192f8"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList = signerList; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestBulkSendWithTemplate.cs b/examples/SignatureRequestBulkSendWithTemplate.cs deleted file mode 100644 index bf1851b5b..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.cs +++ /dev/null @@ -1,81 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signerList1Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td" - ); - - var signerList1CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "ABC Corp" - ); - - var signerList1 = new SubBulkSignerList( - signers: new List(){signerList1Signer}, - customFields: new List(){signerList1CustomFields} - ); - - var signerList2Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b" - ); - - var signerList2CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "123 Corp" - ); - - var signerList2 = new SubBulkSignerList( - signers: new List(){signerList2Signer}, - customFields: new List(){signerList2CustomFields} - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); - - var data = new SignatureRequestBulkSendWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: new List(){signerList1, signerList2}, - ccs: new List(){cc1}, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestBulkSendWithTemplate(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/examples/SignatureRequestBulkSendWithTemplate.java b/examples/SignatureRequestBulkSendWithTemplate.java deleted file mode 100644 index 960d1cbe8..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.java +++ /dev/null @@ -1,73 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestBulkSendWithTemplate.js b/examples/SignatureRequestBulkSendWithTemplate.js deleted file mode 100644 index 088d2e1cf..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.js +++ /dev/null @@ -1,65 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields = { - name: "company", - value: "ABC Corp", -}; - -const signerList1 = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields = { - name: "company", - value: "123 LLC", -}; - -const signerList2 = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkSendWithTemplate.php b/examples/SignatureRequestBulkSendWithTemplate.php deleted file mode 100644 index 0b147a75e..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.php +++ /dev/null @@ -1,62 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com") - ->setPin("d79a3td"); - -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); - -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); - -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$data = new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestBulkSendWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestBulkSendWithTemplate.py b/examples/SignatureRequestBulkSendWithTemplate.py deleted file mode 100644 index f1206792d..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.py +++ /dev/null @@ -1,67 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", - ) - - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="ABC Corp", - ) - - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) - - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", - ) - - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", - ) - - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.SignatureRequestBulkSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_bulk_send_with_template(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestBulkSendWithTemplate.rb b/examples/SignatureRequestBulkSendWithTemplate.rb deleted file mode 100644 index 125bc06ea..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.rb +++ /dev/null @@ -1,58 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" - -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" - -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] - -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" - -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" - -signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = signature_request_api.signature_request_bulk_send_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestBulkSendWithTemplate.ts b/examples/SignatureRequestBulkSendWithTemplate.ts deleted file mode 100644 index b2eb7a923..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.ts +++ /dev/null @@ -1,65 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "ABC Corp", -}; - -const signerList1: DropboxSign.SubBulkSignerList = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "123 LLC", -}; - -const signerList2: DropboxSign.SubBulkSignerList = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data: DropboxSign.SignatureRequestBulkSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.cs b/examples/SignatureRequestBulkSendWithTemplateExample.cs new file mode 100644 index 000000000..3c95fdb32 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest( + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest: signatureRequestBulkSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.java b/examples/SignatureRequestBulkSendWithTemplateExample.java new file mode 100644 index 000000000..fb9baba01 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.php b/examples/SignatureRequestBulkSendWithTemplateExample.php new file mode 100644 index 000000000..7574361ff --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest()) + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkSendWithTemplate( + signature_request_bulk_send_with_template_request: $signature_request_bulk_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.py b/examples/SignatureRequestBulkSendWithTemplateExample.py new file mode 100644 index 000000000..4a8fb41c5 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_send_with_template_request = models.SignatureRequestBulkSendWithTemplateRequest( + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request=signature_request_bulk_send_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: %s\n" % e) diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.rb b/examples/SignatureRequestBulkSendWithTemplateExample.rb new file mode 100644 index 000000000..27f2d66d5 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_send_with_template_request = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new +signature_request_bulk_send_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_send_with_template_request.subject = "Purchase Order" +signature_request_bulk_send_with_template_request.test_mode = true +signature_request_bulk_send_with_template_request.signer_list = signer_list +signature_request_bulk_send_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}" +end diff --git a/examples/SignatureRequestBulkSendWithTemplate.sh b/examples/SignatureRequestBulkSendWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestBulkSendWithTemplate.sh rename to examples/SignatureRequestBulkSendWithTemplateExample.sh diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.ts b/examples/SignatureRequestBulkSendWithTemplateExample.ts new file mode 100644 index 000000000..f2fff90b1 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkSendWithTemplateRequest = new models.SignatureRequestBulkSendWithTemplateRequest(); +signatureRequestBulkSendWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkSendWithTemplateRequest.testMode = true; +signatureRequestBulkSendWithTemplateRequest.signerList = signerList; +signatureRequestBulkSendWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCancel.cs b/examples/SignatureRequestCancel.cs deleted file mode 100644 index cb9549f8f..000000000 --- a/examples/SignatureRequestCancel.cs +++ /dev/null @@ -1,34 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - signatureRequestApi.SignatureRequestCancel(signatureRequestId); - } - 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/SignatureRequestCancel.java b/examples/SignatureRequestCancel.java deleted file mode 100644 index 20c165993..000000000 --- a/examples/SignatureRequestCancel.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - signatureRequestApi.signatureRequestCancel(signatureRequestId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestCancel.js b/examples/SignatureRequestCancel.js deleted file mode 100644 index ba378c467..000000000 --- a/examples/SignatureRequestCancel.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestCancel(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCancel.php b/examples/SignatureRequestCancel.php deleted file mode 100644 index 154dbab93..000000000 --- a/examples/SignatureRequestCancel.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $signatureRequestApi->signatureRequestCancel($signatureRequestId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestCancel.py b/examples/SignatureRequestCancel.py deleted file mode 100644 index 5330623b6..000000000 --- a/examples/SignatureRequestCancel.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - signature_request_api.signature_request_cancel(signature_request_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCancel.rb b/examples/SignatureRequestCancel.rb deleted file mode 100644 index aab12770d..000000000 --- a/examples/SignatureRequestCancel.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_cancel(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCancel.ts b/examples/SignatureRequestCancel.ts deleted file mode 100644 index ba378c467..000000000 --- a/examples/SignatureRequestCancel.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestCancel(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCancelExample.cs b/examples/SignatureRequestCancelExample.cs new file mode 100644 index 000000000..4d18209eb --- /dev/null +++ b/examples/SignatureRequestCancelExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCancelExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new SignatureRequestApi(config).SignatureRequestCancel( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCancel: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCancelExample.java b/examples/SignatureRequestCancelExample.java new file mode 100644 index 000000000..a1e436802 --- /dev/null +++ b/examples/SignatureRequestCancelExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCancelExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCancel"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCancelExample.php b/examples/SignatureRequestCancelExample.php new file mode 100644 index 000000000..969a67683 --- /dev/null +++ b/examples/SignatureRequestCancelExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCancel( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCancel: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCancelExample.py b/examples/SignatureRequestCancelExample.py new file mode 100644 index 000000000..6a0e62bc1 --- /dev/null +++ b/examples/SignatureRequestCancelExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_cancel( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_cancel: %s\n" % e) diff --git a/examples/SignatureRequestCancelExample.rb b/examples/SignatureRequestCancelExample.rb new file mode 100644 index 000000000..9f3ff955e --- /dev/null +++ b/examples/SignatureRequestCancelExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_cancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}" +end diff --git a/examples/SignatureRequestCancel.sh b/examples/SignatureRequestCancelExample.sh similarity index 100% rename from examples/SignatureRequestCancel.sh rename to examples/SignatureRequestCancelExample.sh diff --git a/examples/SignatureRequestCancelExample.ts b/examples/SignatureRequestCancelExample.ts new file mode 100644 index 000000000..d6207b3bd --- /dev/null +++ b/examples/SignatureRequestCancelExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCancel:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCreateEmbedded.cs b/examples/SignatureRequestCreateEmbedded.cs deleted file mode 100644 index 1f587c951..000000000 --- a/examples/SignatureRequestCreateEmbedded.cs +++ /dev/null @@ -1,74 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestCreateEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - signingOptions: signingOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestCreateEmbedded(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/examples/SignatureRequestCreateEmbedded.java b/examples/SignatureRequestCreateEmbedded.java deleted file mode 100644 index 3697f2167..000000000 --- a/examples/SignatureRequestCreateEmbedded.java +++ /dev/null @@ -1,62 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbedded(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestCreateEmbedded.js b/examples/SignatureRequestCreateEmbedded.js deleted file mode 100644 index 14dca9a26..000000000 --- a/examples/SignatureRequestCreateEmbedded.js +++ /dev/null @@ -1,53 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbedded.php b/examples/SignatureRequestCreateEmbedded.php deleted file mode 100644 index 9b416917c..000000000 --- a/examples/SignatureRequestCreateEmbedded.php +++ /dev/null @@ -1,53 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestCreateEmbedded($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestCreateEmbedded.py b/examples/SignatureRequestCreateEmbedded.py deleted file mode 100644 index d35615c96..000000000 --- a/examples/SignatureRequestCreateEmbedded.py +++ /dev/null @@ -1,51 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_create_embedded(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbedded.rb b/examples/SignatureRequestCreateEmbedded.rb deleted file mode 100644 index 4cec8fa11..000000000 --- a/examples/SignatureRequestCreateEmbedded.rb +++ /dev/null @@ -1,46 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_create_embedded(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCreateEmbedded.ts b/examples/SignatureRequestCreateEmbedded.ts deleted file mode 100644 index cad168590..000000000 --- a/examples/SignatureRequestCreateEmbedded.ts +++ /dev/null @@ -1,53 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestCreateEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbeddedExample.cs b/examples/SignatureRequestCreateEmbeddedExample.cs new file mode 100644 index 000000000..7f9786caf --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.cs @@ -0,0 +1,82 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedExample.java b/examples/SignatureRequestCreateEmbeddedExample.java new file mode 100644 index 000000000..ee5f5bb2a --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.java @@ -0,0 +1,78 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedExample.php b/examples/SignatureRequestCreateEmbeddedExample.php new file mode 100644 index 000000000..61d74044e --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.php @@ -0,0 +1,59 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCreateEmbeddedExample.py b/examples/SignatureRequestCreateEmbeddedExample.py new file mode 100644 index 000000000..2e1b93c1d --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.py @@ -0,0 +1,62 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedExample.rb b/examples/SignatureRequestCreateEmbeddedExample.rb new file mode 100644 index 000000000..55db08ca7 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.rb @@ -0,0 +1,55 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbedded.sh b/examples/SignatureRequestCreateEmbeddedExample.sh similarity index 100% rename from examples/SignatureRequestCreateEmbedded.sh rename to examples/SignatureRequestCreateEmbeddedExample.sh diff --git a/examples/SignatureRequestCreateEmbeddedExample.ts b/examples/SignatureRequestCreateEmbeddedExample.ts new file mode 100644 index 000000000..15c30c113 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.ts @@ -0,0 +1,54 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..40cbcbc51 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs @@ -0,0 +1,110 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..0228be4a6 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -0,0 +1,104 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..f7ea5d39a --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php @@ -0,0 +1,86 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py new file mode 100644 index 000000000..8bc255e6f --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py @@ -0,0 +1,92 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb new file mode 100644 index 000000000..9910ee894 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb @@ -0,0 +1,81 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..6fcc1bab3 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts @@ -0,0 +1,80 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.cs b/examples/SignatureRequestCreateEmbeddedWithTemplate.cs deleted file mode 100644 index ff9da4a75..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.cs +++ /dev/null @@ -1,55 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George" - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - signingOptions: subSigningOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestCreateEmbeddedWithTemplate(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/examples/SignatureRequestCreateEmbeddedWithTemplate.java b/examples/SignatureRequestCreateEmbeddedWithTemplate.java deleted file mode 100644 index 96d14e58b..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,53 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.js b/examples/SignatureRequestCreateEmbeddedWithTemplate.js deleted file mode 100644 index 12ba7fc3c..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.js +++ /dev/null @@ -1,41 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.php b/examples/SignatureRequestCreateEmbeddedWithTemplate.php deleted file mode 100644 index 3ff087edb..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.php +++ /dev/null @@ -1,43 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.py b/examples/SignatureRequestCreateEmbeddedWithTemplate.py deleted file mode 100644 index 1b60db43c..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,45 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = ( - signature_request_api.signature_request_create_embedded_with_template(data) - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.rb b/examples/SignatureRequestCreateEmbeddedWithTemplate.rb deleted file mode 100644 index 6aba3fd28..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,39 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.ts b/examples/SignatureRequestCreateEmbeddedWithTemplate.ts deleted file mode 100644 index 993efd82f..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.ts +++ /dev/null @@ -1,41 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestCreateEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..d40f34240 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,66 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..5957ccba0 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..3ff0454e8 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbeddedWithTemplate( + signature_request_create_embedded_with_template_request: $signature_request_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..6a5835760 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,50 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_create_embedded_with_template_request = models.SignatureRequestCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..2de72cf8a --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new +signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_create_embedded_with_template_request.test_mode = true +signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.sh b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestCreateEmbeddedWithTemplate.sh rename to examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..399f0c491 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestCreateEmbeddedWithTemplateRequest = new models.SignatureRequestCreateEmbeddedWithTemplateRequest(); +signatureRequestCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEdit.cs b/examples/SignatureRequestEdit.cs deleted file mode 100644 index 02c197f63..000000000 --- a/examples/SignatureRequestEdit.cs +++ /dev/null @@ -1,87 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var metadata = new Dictionary() - { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestEditRequest( - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: signingOptions, - fieldOptions: subFieldOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEdit(signatureRequestId, 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/examples/SignatureRequestEdit.java b/examples/SignatureRequestEdit.java deleted file mode 100644 index 163b663b0..000000000 --- a/examples/SignatureRequestEdit.java +++ /dev/null @@ -1,69 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEdit.js b/examples/SignatureRequestEdit.js deleted file mode 100644 index 797ffc59e..000000000 --- a/examples/SignatureRequestEdit.js +++ /dev/null @@ -1,84 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestEditRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEdit.php b/examples/SignatureRequestEdit.php deleted file mode 100644 index 67b7c92a5..000000000 --- a/examples/SignatureRequestEdit.php +++ /dev/null @@ -1,62 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\SignatureRequestEditRequest(); -$data->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEdit($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEdit.rb b/examples/SignatureRequestEdit.rb deleted file mode 100644 index b8db7b6b4..000000000 --- a/examples/SignatureRequestEdit.rb +++ /dev/null @@ -1,58 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::SignatureRequestEditRequest.new -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", -] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEdit.ts b/examples/SignatureRequestEdit.ts deleted file mode 100644 index 634c0ba86..000000000 --- a/examples/SignatureRequestEdit.ts +++ /dev/null @@ -1,85 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestEditRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - -const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbedded.cs b/examples/SignatureRequestEditEmbedded.cs deleted file mode 100644 index 87d7d731b..000000000 --- a/examples/SignatureRequestEditEmbedded.cs +++ /dev/null @@ -1,79 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestEditEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - signingOptions: signingOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEditEmbedded( - signatureRequestId, - 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/examples/SignatureRequestEditEmbedded.java b/examples/SignatureRequestEditEmbedded.java deleted file mode 100644 index a9e0ddd22..000000000 --- a/examples/SignatureRequestEditEmbedded.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEditEmbedded.js b/examples/SignatureRequestEditEmbedded.js deleted file mode 100644 index c3b4ae01d..000000000 --- a/examples/SignatureRequestEditEmbedded.js +++ /dev/null @@ -1,58 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbedded.php b/examples/SignatureRequestEditEmbedded.php deleted file mode 100644 index 7af9b39b1..000000000 --- a/examples/SignatureRequestEditEmbedded.php +++ /dev/null @@ -1,58 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEditEmbedded( - $signatureRequestId, - $data - ); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEditEmbedded.py b/examples/SignatureRequestEditEmbedded.py deleted file mode 100644 index 1bbac3c2e..000000000 --- a/examples/SignatureRequestEditEmbedded.py +++ /dev/null @@ -1,55 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestEditEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_embedded( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbedded.rb b/examples/SignatureRequestEditEmbedded.rb deleted file mode 100644 index 6b5d379d4..000000000 --- a/examples/SignatureRequestEditEmbedded.rb +++ /dev/null @@ -1,48 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_embedded(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbedded.ts b/examples/SignatureRequestEditEmbedded.ts deleted file mode 100644 index 49c15b51b..000000000 --- a/examples/SignatureRequestEditEmbedded.ts +++ /dev/null @@ -1,58 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestEditEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbeddedExample.cs b/examples/SignatureRequestEditEmbeddedExample.cs new file mode 100644 index 000000000..356603bf6 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.cs @@ -0,0 +1,83 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedExample.java b/examples/SignatureRequestEditEmbeddedExample.java new file mode 100644 index 000000000..8370a232e --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.java @@ -0,0 +1,79 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedExample.php b/examples/SignatureRequestEditEmbeddedExample.php new file mode 100644 index 000000000..868c62562 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.php @@ -0,0 +1,60 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditEmbeddedExample.py b/examples/SignatureRequestEditEmbeddedExample.py new file mode 100644 index 000000000..e3e5f1a87 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.py @@ -0,0 +1,63 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedExample.rb b/examples/SignatureRequestEditEmbeddedExample.rb new file mode 100644 index 000000000..0e192377c --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.rb @@ -0,0 +1,56 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/examples/SignatureRequestEditEmbedded.sh b/examples/SignatureRequestEditEmbeddedExample.sh similarity index 100% rename from examples/SignatureRequestEditEmbedded.sh rename to examples/SignatureRequestEditEmbeddedExample.sh diff --git a/examples/SignatureRequestEditEmbeddedExample.ts b/examples/SignatureRequestEditEmbeddedExample.ts new file mode 100644 index 000000000..6affce8fb --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.ts @@ -0,0 +1,55 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..3be9c8142 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs @@ -0,0 +1,111 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..8859b04f8 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -0,0 +1,105 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..08ebeac0a --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php @@ -0,0 +1,87 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py new file mode 100644 index 000000000..9c26905c3 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py @@ -0,0 +1,93 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb new file mode 100644 index 000000000..0fc7bc7a3 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb @@ -0,0 +1,82 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..c65767fed --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts @@ -0,0 +1,81 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.cs b/examples/SignatureRequestEditEmbeddedWithTemplate.cs deleted file mode 100644 index 12a591d17..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.cs +++ /dev/null @@ -1,60 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George" - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - signingOptions: subSigningOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - 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/examples/SignatureRequestEditEmbeddedWithTemplate.java b/examples/SignatureRequestEditEmbeddedWithTemplate.java deleted file mode 100644 index c9b68d068..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.java +++ /dev/null @@ -1,58 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.js b/examples/SignatureRequestEditEmbeddedWithTemplate.js deleted file mode 100644 index b4207e848..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.js +++ /dev/null @@ -1,46 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.php b/examples/SignatureRequestEditEmbeddedWithTemplate.php deleted file mode 100644 index 2ab8d4739..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.php +++ /dev/null @@ -1,48 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEditEmbeddedWithTemplate( - $signatureRequestId, - $data - ); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.py b/examples/SignatureRequestEditEmbeddedWithTemplate.py deleted file mode 100644 index 2e0be015e..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.py +++ /dev/null @@ -1,47 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestEditEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_embedded_with_template( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.rb b/examples/SignatureRequestEditEmbeddedWithTemplate.rb deleted file mode 100644 index 4dc4c9e2f..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.rb +++ /dev/null @@ -1,41 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.ts b/examples/SignatureRequestEditEmbeddedWithTemplate.ts deleted file mode 100644 index cfe6cdc55..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.ts +++ /dev/null @@ -1,46 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestEditEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs b/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..fff755e13 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbeddedWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedWithTemplateRequest: signatureRequestEditEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.java b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..77c294dea --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -0,0 +1,68 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.php b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..640f35dfc --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php @@ -0,0 +1,50 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbeddedWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request: $signature_request_edit_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.py b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..92f0378ef --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py @@ -0,0 +1,51 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_edit_embedded_with_template_request = models.SignatureRequestEditEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..f504f1944 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb @@ -0,0 +1,45 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +signature_request_edit_embedded_with_template_request = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new +signature_request_edit_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_edit_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_embedded_with_template_request.subject = "Purchase Order" +signature_request_edit_embedded_with_template_request.test_mode = true +signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.sh b/examples/SignatureRequestEditEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestEditEmbeddedWithTemplate.sh rename to examples/SignatureRequestEditEmbeddedWithTemplateExample.sh diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts b/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..6da9e8e05 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts @@ -0,0 +1,44 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestEditEmbeddedWithTemplateRequest = new models.SignatureRequestEditEmbeddedWithTemplateRequest(); +signatureRequestEditEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestEditEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditEmbeddedWithTemplateRequest.testMode = true; +signatureRequestEditEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditExample.cs b/examples/SignatureRequestEditExample.cs new file mode 100644 index 000000000..b3542b75f --- /dev/null +++ b/examples/SignatureRequestEditExample.cs @@ -0,0 +1,93 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditExample.java b/examples/SignatureRequestEditExample.java new file mode 100644 index 000000000..c0423f9b9 --- /dev/null +++ b/examples/SignatureRequestEditExample.java @@ -0,0 +1,88 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditExample.php b/examples/SignatureRequestEditExample.php new file mode 100644 index 000000000..92d3747c5 --- /dev/null +++ b/examples/SignatureRequestEditExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreate.py b/examples/SignatureRequestEditExample.py similarity index 52% rename from examples/UnclaimedDraftCreate.py rename to examples/SignatureRequestEditExample.py index 3ae301624..4c6fc1e74 100644 --- a/examples/UnclaimedDraftCreate.py +++ b/examples/SignatureRequestEditExample.py @@ -1,62 +1,73 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubUnclaimedDraftSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=False, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, ) - data = models.UnclaimedDraftCreateRequest( + signers = [ + signers_1, + signers_2, + ] + + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", subject="The NDA we talked about", - type="request_signature", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) try: - response = unclaimed_draft_api.unclaimed_draft_create(data) + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling SignatureRequestApi#signature_request_edit: %s\n" % e) diff --git a/examples/SignatureRequestEditExample.rb b/examples/SignatureRequestEditExample.rb new file mode 100644 index 000000000..e55d7beee --- /dev/null +++ b/examples/SignatureRequestEditExample.rb @@ -0,0 +1,66 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/examples/SignatureRequestEdit.sh b/examples/SignatureRequestEditExample.sh similarity index 100% rename from examples/SignatureRequestEdit.sh rename to examples/SignatureRequestEditExample.sh diff --git a/examples/SignatureRequestEditExample.ts b/examples/SignatureRequestEditExample.ts new file mode 100644 index 000000000..43aca782d --- /dev/null +++ b/examples/SignatureRequestEditExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.signers = signers; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditGroupedSignersExample.cs b/examples/SignatureRequestEditGroupedSignersExample.cs new file mode 100644 index 000000000..35a41afa4 --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.cs @@ -0,0 +1,121 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditGroupedSignersExample.java b/examples/SignatureRequestEditGroupedSignersExample.java new file mode 100644 index 000000000..693b72c6c --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.java @@ -0,0 +1,114 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditGroupedSignersExample.php b/examples/SignatureRequestEditGroupedSignersExample.php new file mode 100644 index 000000000..af25d631a --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.php @@ -0,0 +1,96 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditGroupedSignersExample.py b/examples/SignatureRequestEditGroupedSignersExample.py new file mode 100644 index 000000000..41f5a54dc --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.py @@ -0,0 +1,103 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit: %s\n" % e) diff --git a/examples/SignatureRequestEditGroupedSignersExample.rb b/examples/SignatureRequestEditGroupedSignersExample.rb new file mode 100644 index 000000000..2b19ffabb --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.rb @@ -0,0 +1,92 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/examples/SignatureRequestEditGroupedSignersExample.ts b/examples/SignatureRequestEditGroupedSignersExample.ts new file mode 100644 index 000000000..fe5e19645 --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.ts @@ -0,0 +1,88 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditWithTemplate.cs b/examples/SignatureRequestEditWithTemplate.cs deleted file mode 100644 index 22038ee87..000000000 --- a/examples/SignatureRequestEditWithTemplate.cs +++ /dev/null @@ -1,71 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - emailAddress: "george@example.com", - name: "George" - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@emaple.com" - ); - - var customField1 = new SubCustomField( - name: "Cost", - value: "$20,000", - editor: "Client", - required: true - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestEditWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - ccs: new List(){cc1}, - customFields: new List(){customField1}, - signingOptions: signingOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEditWithTemplate(signatureRequestId, 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/examples/SignatureRequestEditWithTemplate.java b/examples/SignatureRequestEditWithTemplate.java deleted file mode 100644 index da6677231..000000000 --- a/examples/SignatureRequestEditWithTemplate.java +++ /dev/null @@ -1,70 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEditWithTemplate.js b/examples/SignatureRequestEditWithTemplate.js deleted file mode 100644 index 3bc93e246..000000000 --- a/examples/SignatureRequestEditWithTemplate.js +++ /dev/null @@ -1,59 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1 = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data, -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditWithTemplate.php b/examples/SignatureRequestEditWithTemplate.php deleted file mode 100644 index d9fe64d46..000000000 --- a/examples/SignatureRequestEditWithTemplate.php +++ /dev/null @@ -1,56 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") - ->setEditor("Client") - ->setRequired(true); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEditWithTemplate($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEditWithTemplate.rb b/examples/SignatureRequestEditWithTemplate.rb deleted file mode 100644 index dacbaba5f..000000000 --- a/examples/SignatureRequestEditWithTemplate.rb +++ /dev/null @@ -1,52 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "george@example.com" -signer_1.name = "George" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -custom_field_1 = Dropbox::Sign::SubCustomField.new -custom_field_1.name = "Cost" -custom_field_1.value = "$20,000" -custom_field_1.editor = "Client" -custom_field_1.required = true - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.ccs = [cc_1] -data.custom_fields = [custom_field_1] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_with_template(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditWithTemplate.ts b/examples/SignatureRequestEditWithTemplate.ts deleted file mode 100644 index d18720403..000000000 --- a/examples/SignatureRequestEditWithTemplate.ts +++ /dev/null @@ -1,59 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1: DropboxSign.SubCustomField = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditWithTemplateExample.cs b/examples/SignatureRequestEditWithTemplateExample.cs new file mode 100644 index 000000000..172f24b6c --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.cs @@ -0,0 +1,90 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditWithTemplateRequest: signatureRequestEditWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditWithTemplateExample.java b/examples/SignatureRequestEditWithTemplateExample.java new file mode 100644 index 000000000..bcb4128d6 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditWithTemplateExample.php b/examples/SignatureRequestEditWithTemplateExample.php new file mode 100644 index 000000000..aa8391c3e --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_edit_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request: $signature_request_edit_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditWithTemplateExample.py b/examples/SignatureRequestEditWithTemplateExample.py new file mode 100644 index 000000000..4e8653475 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.py @@ -0,0 +1,72 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( + name="Cost", + editor="Client", + required=True, + value="$20,000", + ) + + custom_fields = [ + custom_fields_1, + ] + + signature_request_edit_with_template_request = models.SignatureRequestEditWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_with_template: %s\n" % e) diff --git a/examples/SignatureRequestEditWithTemplateExample.rb b/examples/SignatureRequestEditWithTemplateExample.rb new file mode 100644 index 000000000..f3c2d8ed6 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.rb @@ -0,0 +1,64 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +custom_fields_1 = Dropbox::Sign::SubCustomField.new +custom_fields_1.name = "Cost" +custom_fields_1.editor = "Client" +custom_fields_1.required = true +custom_fields_1.value = "$20,000" + +custom_fields = [ + custom_fields_1, +] + +signature_request_edit_with_template_request = Dropbox::Sign::SignatureRequestEditWithTemplateRequest.new +signature_request_edit_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_edit_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_with_template_request.subject = "Purchase Order" +signature_request_edit_with_template_request.test_mode = true +signature_request_edit_with_template_request.signing_options = signing_options +signature_request_edit_with_template_request.signers = signers +signature_request_edit_with_template_request.ccs = ccs +signature_request_edit_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}" +end diff --git a/examples/SignatureRequestEditWithTemplate.sh b/examples/SignatureRequestEditWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestEditWithTemplate.sh rename to examples/SignatureRequestEditWithTemplateExample.sh diff --git a/examples/SignatureRequestEditWithTemplateExample.ts b/examples/SignatureRequestEditWithTemplateExample.ts new file mode 100644 index 000000000..650ce2ff1 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.ts @@ -0,0 +1,63 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestEditWithTemplateRequest = new models.SignatureRequestEditWithTemplateRequest(); +signatureRequestEditWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestEditWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditWithTemplateRequest.testMode = true; +signatureRequestEditWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditWithTemplateRequest.signers = signers; +signatureRequestEditWithTemplateRequest.ccs = ccs; +signatureRequestEditWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestFiles.cs b/examples/SignatureRequestFiles.cs deleted file mode 100644 index d9ceb40a6..000000000 --- a/examples/SignatureRequestFiles.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestFiles(signatureRequestId, "pdf"); - - 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/SignatureRequestFiles.java b/examples/SignatureRequestFiles.java deleted file mode 100644 index ca70f2321..000000000 --- a/examples/SignatureRequestFiles.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf"); - result.renameTo(new File("file_response.pdf")); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestFiles.js b/examples/SignatureRequestFiles.js deleted file mode 100644 index 309fea4d9..000000000 --- a/examples/SignatureRequestFiles.js +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -const fileType = "pdf"; - -const result = signatureRequestApi.signatureRequestFiles(signatureRequestId, fileType); - -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFiles.php b/examples/SignatureRequestFiles.php deleted file mode 100644 index 9fc70c7c2..000000000 --- a/examples/SignatureRequestFiles.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -$fileType = "pdf"; - -try { - $result = $signatureRequestApi->signatureRequestFiles($signatureRequestId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestFiles.py b/examples/SignatureRequestFiles.py deleted file mode 100644 index 1c32d32c4..000000000 --- a/examples/SignatureRequestFiles.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files( - signature_request_id, file_type="pdf" - ) - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFiles.rb b/examples/SignatureRequestFiles.rb deleted file mode 100644 index 171082637..000000000 --- a/examples/SignatureRequestFiles.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - file_bin = signature_request_api.signature_request_files(signature_request_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFiles.ts b/examples/SignatureRequestFiles.ts deleted file mode 100644 index 309fea4d9..000000000 --- a/examples/SignatureRequestFiles.ts +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -const fileType = "pdf"; - -const result = signatureRequestApi.signatureRequestFiles(signatureRequestId, fileType); - -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsDataUri.cs b/examples/SignatureRequestFilesAsDataUri.cs deleted file mode 100644 index 5ca7ca5bc..000000000 --- a/examples/SignatureRequestFilesAsDataUri.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestFilesAsDataUri(signatureRequestId); - 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/SignatureRequestFilesAsDataUri.java b/examples/SignatureRequestFilesAsDataUri.java deleted file mode 100644 index b90222308..000000000 --- a/examples/SignatureRequestFilesAsDataUri.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FileResponseDataUri result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestFilesAsDataUri.js b/examples/SignatureRequestFilesAsDataUri.js deleted file mode 100644 index 6836ecc1a..000000000 --- a/examples/SignatureRequestFilesAsDataUri.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsDataUri.php b/examples/SignatureRequestFilesAsDataUri.php deleted file mode 100644 index 7ae6b9df1..000000000 --- a/examples/SignatureRequestFilesAsDataUri.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestFilesAsDataUri($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestFilesAsDataUri.py b/examples/SignatureRequestFilesAsDataUri.py deleted file mode 100644 index 46bb01562..000000000 --- a/examples/SignatureRequestFilesAsDataUri.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files_as_data_uri( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsDataUri.rb b/examples/SignatureRequestFilesAsDataUri.rb deleted file mode 100644 index b95c37443..000000000 --- a/examples/SignatureRequestFilesAsDataUri.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = signature_request_api.signature_request_files_as_data_uri(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsDataUri.ts b/examples/SignatureRequestFilesAsDataUri.ts deleted file mode 100644 index 6836ecc1a..000000000 --- a/examples/SignatureRequestFilesAsDataUri.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsDataUriExample.cs b/examples/SignatureRequestFilesAsDataUriExample.cs new file mode 100644 index 000000000..60f837089 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsDataUri( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestFilesAsDataUriExample.java b/examples/SignatureRequestFilesAsDataUriExample.java new file mode 100644 index 000000000..765fb93ce --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestFilesAsDataUriExample.php b/examples/SignatureRequestFilesAsDataUriExample.php new file mode 100644 index 000000000..0d8d71902 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsDataUri( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestFilesAsDataUriExample.py b/examples/SignatureRequestFilesAsDataUriExample.py new file mode 100644 index 000000000..09a50923d --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files_as_data_uri( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsDataUriExample.rb b/examples/SignatureRequestFilesAsDataUriExample.rb new file mode 100644 index 000000000..9f9390e41 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_data_uri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}" +end diff --git a/examples/SignatureRequestFilesAsDataUri.sh b/examples/SignatureRequestFilesAsDataUriExample.sh similarity index 100% rename from examples/SignatureRequestFilesAsDataUri.sh rename to examples/SignatureRequestFilesAsDataUriExample.sh diff --git a/examples/SignatureRequestFilesAsDataUriExample.ts b/examples/SignatureRequestFilesAsDataUriExample.ts new file mode 100644 index 000000000..58630aeaa --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestFilesAsFileUrl.cs b/examples/SignatureRequestFilesAsFileUrl.cs deleted file mode 100644 index b3e92efd1..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestFilesAsFileUrl(signatureRequestId); - 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/SignatureRequestFilesAsFileUrl.java b/examples/SignatureRequestFilesAsFileUrl.java deleted file mode 100644 index 7bf3b9907..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FileResponse result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestFilesAsFileUrl.js b/examples/SignatureRequestFilesAsFileUrl.js deleted file mode 100644 index bb866605d..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsFileUrl.php b/examples/SignatureRequestFilesAsFileUrl.php deleted file mode 100644 index 91af0a41c..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestFilesAsFileUrl($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestFilesAsFileUrl.py b/examples/SignatureRequestFilesAsFileUrl.py deleted file mode 100644 index 9c6a5da4f..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files_as_file_url( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsFileUrl.rb b/examples/SignatureRequestFilesAsFileUrl.rb deleted file mode 100644 index a4294a288..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = signature_request_api.signature_request_files_as_file_url(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsFileUrl.ts b/examples/SignatureRequestFilesAsFileUrl.ts deleted file mode 100644 index bb866605d..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsFileUrlExample.cs b/examples/SignatureRequestFilesAsFileUrlExample.cs new file mode 100644 index 000000000..f3bfe667a --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsFileUrl( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestFilesAsFileUrlExample.java b/examples/SignatureRequestFilesAsFileUrlExample.java new file mode 100644 index 000000000..62e253779 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestFilesAsFileUrlExample.php b/examples/SignatureRequestFilesAsFileUrlExample.php new file mode 100644 index 000000000..feb6ac055 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsFileUrl( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestFilesAsFileUrlExample.py b/examples/SignatureRequestFilesAsFileUrlExample.py new file mode 100644 index 000000000..9cd19e6db --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files_as_file_url( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files_as_file_url: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsFileUrlExample.rb b/examples/SignatureRequestFilesAsFileUrlExample.rb new file mode 100644 index 000000000..14abf28bf --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_file_url( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}" +end diff --git a/examples/SignatureRequestFilesAsFileUrl.sh b/examples/SignatureRequestFilesAsFileUrlExample.sh similarity index 100% rename from examples/SignatureRequestFilesAsFileUrl.sh rename to examples/SignatureRequestFilesAsFileUrlExample.sh diff --git a/examples/SignatureRequestFilesAsFileUrlExample.ts b/examples/SignatureRequestFilesAsFileUrlExample.ts new file mode 100644 index 000000000..5ca65d932 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestFilesExample.cs b/examples/SignatureRequestFilesExample.cs new file mode 100644 index 000000000..879127eda --- /dev/null +++ b/examples/SignatureRequestFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFiles( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + fileType: "pdf" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestFilesExample.java b/examples/SignatureRequestFilesExample.java new file mode 100644 index 000000000..758d2997b --- /dev/null +++ b/examples/SignatureRequestFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestFilesExample.php b/examples/SignatureRequestFilesExample.php new file mode 100644 index 000000000..b11f5ae30 --- /dev/null +++ b/examples/SignatureRequestFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFiles( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type: "pdf", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFiles: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestFilesExample.py b/examples/SignatureRequestFilesExample.py new file mode 100644 index 000000000..12694cc53 --- /dev/null +++ b/examples/SignatureRequestFilesExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type="pdf", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files: %s\n" % e) diff --git a/examples/SignatureRequestFilesExample.rb b/examples/SignatureRequestFilesExample.rb new file mode 100644 index 000000000..1d891d696 --- /dev/null +++ b/examples/SignatureRequestFilesExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + file_type: "pdf", + }, + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}" +end diff --git a/examples/SignatureRequestFiles.sh b/examples/SignatureRequestFilesExample.sh similarity index 100% rename from examples/SignatureRequestFiles.sh rename to examples/SignatureRequestFilesExample.sh diff --git a/examples/SignatureRequestFilesExample.ts b/examples/SignatureRequestFilesExample.ts new file mode 100644 index 000000000..88762904f --- /dev/null +++ b/examples/SignatureRequestFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf", // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFiles:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestGet.cs b/examples/SignatureRequestGet.cs deleted file mode 100644 index 33425be0a..000000000 --- a/examples/SignatureRequestGet.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestGet(signatureRequestId); - 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/SignatureRequestGet.java b/examples/SignatureRequestGet.java deleted file mode 100644 index 78e4af53c..000000000 --- a/examples/SignatureRequestGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestGet(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestGet.js b/examples/SignatureRequestGet.js deleted file mode 100644 index 894f53bcc..000000000 --- a/examples/SignatureRequestGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestGet(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestGet.php b/examples/SignatureRequestGet.php deleted file mode 100644 index a7eed1bb0..000000000 --- a/examples/SignatureRequestGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestGet($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestGet.py b/examples/SignatureRequestGet.py deleted file mode 100644 index 50d34099e..000000000 --- a/examples/SignatureRequestGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_get(signature_request_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestGet.rb b/examples/SignatureRequestGet.rb deleted file mode 100644 index 35721b8f9..000000000 --- a/examples/SignatureRequestGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = signature_request_api.signature_request_get(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestGet.ts b/examples/SignatureRequestGet.ts deleted file mode 100644 index 894f53bcc..000000000 --- a/examples/SignatureRequestGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestGet(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestGetExample.cs b/examples/SignatureRequestGetExample.cs new file mode 100644 index 000000000..388861f1f --- /dev/null +++ b/examples/SignatureRequestGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestGet( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestGetExample.java b/examples/SignatureRequestGetExample.java new file mode 100644 index 000000000..b93d099d6 --- /dev/null +++ b/examples/SignatureRequestGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestGetExample.php b/examples/SignatureRequestGetExample.php new file mode 100644 index 000000000..dfb79eda9 --- /dev/null +++ b/examples/SignatureRequestGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestGet( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestGet: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestGetExample.py b/examples/SignatureRequestGetExample.py new file mode 100644 index 000000000..47359ef9c --- /dev/null +++ b/examples/SignatureRequestGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_get( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_get: %s\n" % e) diff --git a/examples/SignatureRequestGetExample.rb b/examples/SignatureRequestGetExample.rb new file mode 100644 index 000000000..6399f34f6 --- /dev/null +++ b/examples/SignatureRequestGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}" +end diff --git a/examples/SignatureRequestGet.sh b/examples/SignatureRequestGetExample.sh similarity index 100% rename from examples/SignatureRequestGet.sh rename to examples/SignatureRequestGetExample.sh diff --git a/examples/SignatureRequestGetExample.ts b/examples/SignatureRequestGetExample.ts new file mode 100644 index 000000000..05ea209b6 --- /dev/null +++ b/examples/SignatureRequestGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestGet:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestList.cs b/examples/SignatureRequestList.cs deleted file mode 100644 index 56129479b..000000000 --- a/examples/SignatureRequestList.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var accountId = "accountId"; - - try - { - var result = signatureRequestApi.SignatureRequestList(accountId); - 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/SignatureRequestList.java b/examples/SignatureRequestList.java deleted file mode 100644 index 1afcd8b34..000000000 --- a/examples/SignatureRequestList.java +++ /dev/null @@ -1,41 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var accountId = "accountId"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - SignatureRequestListResponse result = signatureRequestApi.signatureRequestList( - accountId, - page, - pageSize, - query - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestList.js b/examples/SignatureRequestList.js deleted file mode 100644 index a25f34433..000000000 --- a/examples/SignatureRequestList.js +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = null; -const page = 1; - -const result = signatureRequestApi.signatureRequestList(accountId, page); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestList.php b/examples/SignatureRequestList.php deleted file mode 100644 index 16ef2306e..000000000 --- a/examples/SignatureRequestList.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$accountId = null; -$page = 1; - -try { - $result = $signatureRequestApi->signatureRequestList($accountId, $page); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestList.py b/examples/SignatureRequestList.py deleted file mode 100644 index b35f92b06..000000000 --- a/examples/SignatureRequestList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - account_id = None - page = 1 - - try: - response = signature_request_api.signature_request_list( - account_id=account_id, - page=page, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestList.rb b/examples/SignatureRequestList.rb deleted file mode 100644 index 30a4c49fd..000000000 --- a/examples/SignatureRequestList.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -account_id = null -page = 1 - -begin - result = signature_request_api.signature_request_list({ account_id: account_id, page: page }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestList.ts b/examples/SignatureRequestList.ts deleted file mode 100644 index a25f34433..000000000 --- a/examples/SignatureRequestList.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = null; -const page = 1; - -const result = signatureRequestApi.signatureRequestList(accountId, page); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestListExample.cs b/examples/SignatureRequestListExample.cs new file mode 100644 index 000000000..d5b2bfb9d --- /dev/null +++ b/examples/SignatureRequestListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestListExample.java b/examples/SignatureRequestListExample.java new file mode 100644 index 000000000..76f018548 --- /dev/null +++ b/examples/SignatureRequestListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestListExample.php b/examples/SignatureRequestListExample.php new file mode 100644 index 000000000..c11043fcf --- /dev/null +++ b/examples/SignatureRequestListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestListExample.py b/examples/SignatureRequestListExample.py new file mode 100644 index 000000000..6d3db2fe3 --- /dev/null +++ b/examples/SignatureRequestListExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_list( + account_id=None, + page=1, + page_size=20, + query=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_list: %s\n" % e) diff --git a/examples/SignatureRequestListExample.rb b/examples/SignatureRequestListExample.rb new file mode 100644 index 000000000..2fcc01276 --- /dev/null +++ b/examples/SignatureRequestListExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}" +end diff --git a/examples/SignatureRequestList.sh b/examples/SignatureRequestListExample.sh similarity index 100% rename from examples/SignatureRequestList.sh rename to examples/SignatureRequestListExample.sh diff --git a/examples/SignatureRequestListExample.ts b/examples/SignatureRequestListExample.ts new file mode 100644 index 000000000..20d63eddb --- /dev/null +++ b/examples/SignatureRequestListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestList:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestReleaseHold.cs b/examples/SignatureRequestReleaseHold.cs deleted file mode 100644 index 5819bb9a7..000000000 --- a/examples/SignatureRequestReleaseHold.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestReleaseHold(signatureRequestId); - 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/SignatureRequestReleaseHold.java b/examples/SignatureRequestReleaseHold.java deleted file mode 100644 index c17085aca..000000000 --- a/examples/SignatureRequestReleaseHold.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestReleaseHold.js b/examples/SignatureRequestReleaseHold.js deleted file mode 100644 index be4707943..000000000 --- a/examples/SignatureRequestReleaseHold.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestReleaseHold.php b/examples/SignatureRequestReleaseHold.php deleted file mode 100644 index cfaf1104b..000000000 --- a/examples/SignatureRequestReleaseHold.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestReleaseHold($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestReleaseHold.py b/examples/SignatureRequestReleaseHold.py deleted file mode 100644 index 4f6b26a0b..000000000 --- a/examples/SignatureRequestReleaseHold.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_release_hold( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestReleaseHold.rb b/examples/SignatureRequestReleaseHold.rb deleted file mode 100644 index e31f863fd..000000000 --- a/examples/SignatureRequestReleaseHold.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_release_hold(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestReleaseHold.ts b/examples/SignatureRequestReleaseHold.ts deleted file mode 100644 index be4707943..000000000 --- a/examples/SignatureRequestReleaseHold.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestReleaseHoldExample.cs b/examples/SignatureRequestReleaseHoldExample.cs new file mode 100644 index 000000000..9b64cd74c --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestReleaseHoldExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestReleaseHold( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestReleaseHold: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestReleaseHoldExample.java b/examples/SignatureRequestReleaseHoldExample.java new file mode 100644 index 000000000..521794ef1 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestReleaseHoldExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestReleaseHold"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestReleaseHoldExample.php b/examples/SignatureRequestReleaseHoldExample.php new file mode 100644 index 000000000..dcbbd1b31 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestReleaseHold( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestReleaseHold: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestReleaseHoldExample.py b/examples/SignatureRequestReleaseHoldExample.py new file mode 100644 index 000000000..e584b4fd2 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_release_hold( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_release_hold: %s\n" % e) diff --git a/examples/SignatureRequestReleaseHoldExample.rb b/examples/SignatureRequestReleaseHoldExample.rb new file mode 100644 index 000000000..422ab2d05 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_release_hold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}" +end diff --git a/examples/SignatureRequestReleaseHold.sh b/examples/SignatureRequestReleaseHoldExample.sh similarity index 100% rename from examples/SignatureRequestReleaseHold.sh rename to examples/SignatureRequestReleaseHoldExample.sh diff --git a/examples/SignatureRequestReleaseHoldExample.ts b/examples/SignatureRequestReleaseHoldExample.ts new file mode 100644 index 000000000..3dca1e10d --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestReleaseHold:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestRemind.cs b/examples/SignatureRequestRemind.cs deleted file mode 100644 index 1dc8f6d68..000000000 --- a/examples/SignatureRequestRemind.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var data = new SignatureRequestRemindRequest( - emailAddress: "john@example.com" - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestRemind(signatureRequestId, 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/examples/SignatureRequestRemind.java b/examples/SignatureRequestRemind.java deleted file mode 100644 index be5d42a1a..000000000 --- a/examples/SignatureRequestRemind.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestRemindRequest() - .emailAddress("john@example.com"); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestRemind.js b/examples/SignatureRequestRemind.js deleted file mode 100644 index 3e582ed72..000000000 --- a/examples/SignatureRequestRemind.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "john@example.com", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemind.php b/examples/SignatureRequestRemind.php deleted file mode 100644 index 059803134..000000000 --- a/examples/SignatureRequestRemind.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestRemindRequest(); -$data->setEmailAddress("john@example.com"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestRemind($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestRemind.py b/examples/SignatureRequestRemind.py deleted file mode 100644 index 52d093fe8..000000000 --- a/examples/SignatureRequestRemind.py +++ /dev/null @@ -1,27 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestRemindRequest( - email_address="john@example.com", - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_remind( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestRemind.rb b/examples/SignatureRequestRemind.rb deleted file mode 100644 index 10979a437..000000000 --- a/examples/SignatureRequestRemind.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestRemindRequest.new -data.email_address = "john@example.com" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_remind(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestRemind.ts b/examples/SignatureRequestRemind.ts deleted file mode 100644 index cfe7cef10..000000000 --- a/examples/SignatureRequestRemind.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.SignatureRequestRemindRequest = { - emailAddress: "john@example.com", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemindExample.cs b/examples/SignatureRequestRemindExample.cs new file mode 100644 index 000000000..bef1acbf1 --- /dev/null +++ b/examples/SignatureRequestRemindExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemindExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest( + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestRemind( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestRemindRequest: signatureRequestRemindRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemind: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestRemindExample.java b/examples/SignatureRequestRemindExample.java new file mode 100644 index 000000000..23830d9d3 --- /dev/null +++ b/examples/SignatureRequestRemindExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemindExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemind"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestRemindExample.php b/examples/SignatureRequestRemindExample.php new file mode 100644 index 000000000..10b5086a4 --- /dev/null +++ b/examples/SignatureRequestRemindExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_remind_request = (new Dropbox\Sign\Model\SignatureRequestRemindRequest()) + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemind( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request: $signature_request_remind_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemind: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestRemindExample.py b/examples/SignatureRequestRemindExample.py new file mode 100644 index 000000000..048db3092 --- /dev/null +++ b/examples/SignatureRequestRemindExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_remind_request = models.SignatureRequestRemindRequest( + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_remind( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request=signature_request_remind_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_remind: %s\n" % e) diff --git a/examples/SignatureRequestRemindExample.rb b/examples/SignatureRequestRemindExample.rb new file mode 100644 index 000000000..722928d9e --- /dev/null +++ b/examples/SignatureRequestRemindExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new +signature_request_remind_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_remind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_remind_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}" +end diff --git a/examples/SignatureRequestRemind.sh b/examples/SignatureRequestRemindExample.sh similarity index 100% rename from examples/SignatureRequestRemind.sh rename to examples/SignatureRequestRemindExample.sh diff --git a/examples/SignatureRequestRemindExample.ts b/examples/SignatureRequestRemindExample.ts new file mode 100644 index 000000000..fa558c1d6 --- /dev/null +++ b/examples/SignatureRequestRemindExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestRemindRequest = new models.SignatureRequestRemindRequest(); +signatureRequestRemindRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemind:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestRemove.cs b/examples/SignatureRequestRemove.cs deleted file mode 100644 index f60968345..000000000 --- a/examples/SignatureRequestRemove.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - signatureRequestApi.SignatureRequestRemove(signatureRequestId); - } - 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/SignatureRequestRemove.java b/examples/SignatureRequestRemove.java deleted file mode 100644 index 90ba45bf3..000000000 --- a/examples/SignatureRequestRemove.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - signatureRequestApi.signatureRequestRemove(signatureRequestId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestRemove.js b/examples/SignatureRequestRemove.js deleted file mode 100644 index 189a44578..000000000 --- a/examples/SignatureRequestRemove.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemove(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemove.php b/examples/SignatureRequestRemove.php deleted file mode 100644 index ad60276c6..000000000 --- a/examples/SignatureRequestRemove.php +++ /dev/null @@ -1,20 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $signatureRequestApi->signatureRequestRemove($signatureRequestId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestRemove.py b/examples/SignatureRequestRemove.py deleted file mode 100644 index 0663bf869..000000000 --- a/examples/SignatureRequestRemove.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - signature_request_api.signature_request_remove(signature_request_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestRemove.rb b/examples/SignatureRequestRemove.rb deleted file mode 100644 index 63937f53e..000000000 --- a/examples/SignatureRequestRemove.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_remove(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestRemove.ts b/examples/SignatureRequestRemove.ts deleted file mode 100644 index 189a44578..000000000 --- a/examples/SignatureRequestRemove.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemove(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineCreate.cs b/examples/SignatureRequestRemoveExample.cs similarity index 53% rename from examples/FaxLineCreate.cs rename to examples/SignatureRequestRemoveExample.cs index 4d96ae5b0..f0b9cf86e 100644 --- a/examples/FaxLineCreate.cs +++ b/examples/SignatureRequestRemoveExample.cs @@ -1,32 +1,30 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemoveExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineCreateRequest( - areaCode: 209, - country: "US" - ); - try { - var result = faxLineApi.FaxLineCreate(data); - Console.WriteLine(result); + new SignatureRequestApi(config).SignatureRequestRemove( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemove: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/SignatureRequestRemoveExample.java b/examples/SignatureRequestRemoveExample.java new file mode 100644 index 000000000..d205e388a --- /dev/null +++ b/examples/SignatureRequestRemoveExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemove"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestRemoveExample.php b/examples/SignatureRequestRemoveExample.php new file mode 100644 index 000000000..87ecc7e6f --- /dev/null +++ b/examples/SignatureRequestRemoveExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemove( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemove: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestRemoveExample.py b/examples/SignatureRequestRemoveExample.py new file mode 100644 index 000000000..3a380080b --- /dev/null +++ b/examples/SignatureRequestRemoveExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_remove( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_remove: %s\n" % e) diff --git a/examples/SignatureRequestRemoveExample.rb b/examples/SignatureRequestRemoveExample.rb new file mode 100644 index 000000000..7940519df --- /dev/null +++ b/examples/SignatureRequestRemoveExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_remove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}" +end diff --git a/examples/SignatureRequestRemove.sh b/examples/SignatureRequestRemoveExample.sh similarity index 100% rename from examples/SignatureRequestRemove.sh rename to examples/SignatureRequestRemoveExample.sh diff --git a/examples/SignatureRequestRemoveExample.ts b/examples/SignatureRequestRemoveExample.ts new file mode 100644 index 000000000..7f76eb5a2 --- /dev/null +++ b/examples/SignatureRequestRemoveExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemove:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestSend.cs b/examples/SignatureRequestSend.cs deleted file mode 100644 index c1d45d1f1..000000000 --- a/examples/SignatureRequestSend.cs +++ /dev/null @@ -1,85 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var metadata = new Dictionary() - { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestSendRequest( - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: signingOptions, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestSend(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/examples/SignatureRequestSend.java b/examples/SignatureRequestSend.java deleted file mode 100644 index 4382c852b..000000000 --- a/examples/SignatureRequestSend.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new SignatureRequestSendRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSend(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestSend.js b/examples/SignatureRequestSend.js deleted file mode 100644 index 1735a30a9..000000000 --- a/examples/SignatureRequestSend.js +++ /dev/null @@ -1,82 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSend.php b/examples/SignatureRequestSend.php deleted file mode 100644 index 419d7acd9..000000000 --- a/examples/SignatureRequestSend.php +++ /dev/null @@ -1,60 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\SignatureRequestSendRequest(); -$data->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestSend($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestSend.rb b/examples/SignatureRequestSend.rb deleted file mode 100644 index d6981f2b2..000000000 --- a/examples/SignatureRequestSend.rb +++ /dev/null @@ -1,56 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::SignatureRequestSendRequest.new -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", -] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_send(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestSend.ts b/examples/SignatureRequestSend.ts deleted file mode 100644 index ca321ca9a..000000000 --- a/examples/SignatureRequestSend.ts +++ /dev/null @@ -1,82 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestSendRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSendExample.cs b/examples/SignatureRequestSendExample.cs new file mode 100644 index 000000000..2958c264c --- /dev/null +++ b/examples/SignatureRequestSendExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestSendExample.java b/examples/SignatureRequestSendExample.java new file mode 100644 index 000000000..2a57da157 --- /dev/null +++ b/examples/SignatureRequestSendExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestSendExample.php b/examples/SignatureRequestSendExample.php new file mode 100644 index 000000000..f922a579e --- /dev/null +++ b/examples/SignatureRequestSendExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEdit.py b/examples/SignatureRequestSendExample.py similarity index 55% rename from examples/SignatureRequestEdit.py rename to examples/SignatureRequestSendExample.py index 213bed8b4..21b1bfc26 100644 --- a/examples/SignatureRequestEdit.py +++ b/examples/SignatureRequestSendExample.py @@ -1,66 +1,72 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - data = models.SignatureRequestEditRequest( - title="NDA with Acme Co.", + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_edit( - signature_request_id, data + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling SignatureRequestApi#signature_request_send: %s\n" % e) diff --git a/examples/SignatureRequestSendExample.rb b/examples/SignatureRequestSendExample.rb new file mode 100644 index 000000000..28905902d --- /dev/null +++ b/examples/SignatureRequestSendExample.rb @@ -0,0 +1,65 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/examples/SignatureRequestSend.sh b/examples/SignatureRequestSendExample.sh similarity index 100% rename from examples/SignatureRequestSend.sh rename to examples/SignatureRequestSendExample.sh diff --git a/examples/SignatureRequestSendExample.ts b/examples/SignatureRequestSendExample.ts new file mode 100644 index 000000000..c742336fa --- /dev/null +++ b/examples/SignatureRequestSendExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.signers = signers; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestSendGroupedSignersExample.cs b/examples/SignatureRequestSendGroupedSignersExample.cs new file mode 100644 index 000000000..8263d9170 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.cs @@ -0,0 +1,120 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestSendGroupedSignersExample.java b/examples/SignatureRequestSendGroupedSignersExample.java new file mode 100644 index 000000000..14d6d0fba --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.java @@ -0,0 +1,113 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestSendGroupedSignersExample.php b/examples/SignatureRequestSendGroupedSignersExample.php new file mode 100644 index 000000000..bec0368b8 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.php @@ -0,0 +1,95 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestSendGroupedSignersExample.py b/examples/SignatureRequestSendGroupedSignersExample.py new file mode 100644 index 000000000..3a7e649c6 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.py @@ -0,0 +1,102 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_send: %s\n" % e) diff --git a/examples/SignatureRequestSendGroupedSignersExample.rb b/examples/SignatureRequestSendGroupedSignersExample.rb new file mode 100644 index 000000000..dec38e89c --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.rb @@ -0,0 +1,91 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/examples/SignatureRequestSendGroupedSignersExample.ts b/examples/SignatureRequestSendGroupedSignersExample.ts new file mode 100644 index 000000000..d7414588a --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.ts @@ -0,0 +1,87 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestSendWithTemplate.cs b/examples/SignatureRequestSendWithTemplate.cs deleted file mode 100644 index 7c78edcc2..000000000 --- a/examples/SignatureRequestSendWithTemplate.cs +++ /dev/null @@ -1,69 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - emailAddress: "george@example.com", - name: "George" - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@emaple.com" - ); - - var customField1 = new SubCustomField( - name: "Cost", - value: "$20,000", - editor: "Client", - required: true - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestSendWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - ccs: new List(){cc1}, - customFields: new List(){customField1}, - signingOptions: signingOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestSendWithTemplate(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/examples/SignatureRequestSendWithTemplate.java b/examples/SignatureRequestSendWithTemplate.java deleted file mode 100644 index 1907e4d89..000000000 --- a/examples/SignatureRequestSendWithTemplate.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestSendWithTemplate.js b/examples/SignatureRequestSendWithTemplate.js deleted file mode 100644 index cbbb998b2..000000000 --- a/examples/SignatureRequestSendWithTemplate.js +++ /dev/null @@ -1,54 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1 = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSendWithTemplate.php b/examples/SignatureRequestSendWithTemplate.php deleted file mode 100644 index 665105770..000000000 --- a/examples/SignatureRequestSendWithTemplate.php +++ /dev/null @@ -1,54 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") - ->setEditor("Client") - ->setRequired(true); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestSendWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestSendWithTemplate.rb b/examples/SignatureRequestSendWithTemplate.rb deleted file mode 100644 index a31f711ab..000000000 --- a/examples/SignatureRequestSendWithTemplate.rb +++ /dev/null @@ -1,50 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "george@example.com" -signer_1.name = "George" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -custom_field_1 = Dropbox::Sign::SubCustomField.new -custom_field_1.name = "Cost" -custom_field_1.value = "$20,000" -custom_field_1.editor = "Client" -custom_field_1.required = true - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.ccs = [cc_1] -data.custom_fields = [custom_field_1] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_send_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestSendWithTemplate.ts b/examples/SignatureRequestSendWithTemplate.ts deleted file mode 100644 index 2f2135094..000000000 --- a/examples/SignatureRequestSendWithTemplate.ts +++ /dev/null @@ -1,54 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1: DropboxSign.SubCustomField = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSendWithTemplateExample.cs b/examples/SignatureRequestSendWithTemplateExample.cs new file mode 100644 index 000000000..024b92ce8 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.cs @@ -0,0 +1,89 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest: signatureRequestSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestSendWithTemplateExample.java b/examples/SignatureRequestSendWithTemplateExample.java new file mode 100644 index 000000000..fe3a4ce83 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.java @@ -0,0 +1,86 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestSendWithTemplateExample.php b/examples/SignatureRequestSendWithTemplateExample.php new file mode 100644 index 000000000..7c9963cf3 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSendWithTemplate( + signature_request_send_with_template_request: $signature_request_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditWithTemplate.py b/examples/SignatureRequestSendWithTemplateExample.py similarity index 50% rename from examples/SignatureRequestEditWithTemplate.py rename to examples/SignatureRequestSendWithTemplateExample.py index 399b51697..468a6b101 100644 --- a/examples/SignatureRequestEditWithTemplate.py +++ b/examples/SignatureRequestSendWithTemplateExample.py @@ -1,60 +1,71 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubSignatureRequestTemplateSigner( + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - email_address="george@example.com", name="George", + email_address="george@example.com", ) - cc_1 = models.SubCC( + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - custom_field_1 = models.SubCustomField( + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( name="Cost", - value="$20,000", editor="Client", required=True, + value="$20,000", ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) + custom_fields = [ + custom_fields_1, + ] - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", + signature_request_send_with_template_request = models.SignatureRequestSendWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, + subject="Purchase Order", test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_edit_with_template( - signature_request_id, data + response = api.SignatureRequestApi(api_client).signature_request_send_with_template( + signature_request_send_with_template_request=signature_request_send_with_template_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling SignatureRequestApi#signature_request_send_with_template: %s\n" % e) diff --git a/examples/SignatureRequestSendWithTemplateExample.rb b/examples/SignatureRequestSendWithTemplateExample.rb new file mode 100644 index 000000000..4ee78fded --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.rb @@ -0,0 +1,63 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +custom_fields_1 = Dropbox::Sign::SubCustomField.new +custom_fields_1.name = "Cost" +custom_fields_1.editor = "Client" +custom_fields_1.required = true +custom_fields_1.value = "$20,000" + +custom_fields = [ + custom_fields_1, +] + +signature_request_send_with_template_request = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new +signature_request_send_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_send_with_template_request.subject = "Purchase Order" +signature_request_send_with_template_request.test_mode = true +signature_request_send_with_template_request.signing_options = signing_options +signature_request_send_with_template_request.signers = signers +signature_request_send_with_template_request.ccs = ccs +signature_request_send_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send_with_template( + signature_request_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}" +end diff --git a/examples/SignatureRequestSendWithTemplate.sh b/examples/SignatureRequestSendWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestSendWithTemplate.sh rename to examples/SignatureRequestSendWithTemplateExample.sh diff --git a/examples/SignatureRequestSendWithTemplateExample.ts b/examples/SignatureRequestSendWithTemplateExample.ts new file mode 100644 index 000000000..181e37a35 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestSendWithTemplateRequest = new models.SignatureRequestSendWithTemplateRequest(); +signatureRequestSendWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestSendWithTemplateRequest.testMode = true; +signatureRequestSendWithTemplateRequest.signingOptions = signingOptions; +signatureRequestSendWithTemplateRequest.signers = signers; +signatureRequestSendWithTemplateRequest.ccs = ccs; +signatureRequestSendWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestUpdate.cs b/examples/SignatureRequestUpdate.cs deleted file mode 100644 index b8d73b2d0..000000000 --- a/examples/SignatureRequestUpdate.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestUpdateRequest( - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3" - ); - - try - { - var result = signatureRequestApi.SignatureRequestUpdate(signatureRequestId, 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/examples/SignatureRequestUpdate.java b/examples/SignatureRequestUpdate.java deleted file mode 100644 index aca14a22b..000000000 --- a/examples/SignatureRequestUpdate.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestUpdateRequest() - .emailAddress("john@example.com") - .signatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestUpdate.js b/examples/SignatureRequestUpdate.js deleted file mode 100644 index 87372e748..000000000 --- a/examples/SignatureRequestUpdate.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestUpdate.php b/examples/SignatureRequestUpdate.php deleted file mode 100644 index eda22b742..000000000 --- a/examples/SignatureRequestUpdate.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestUpdateRequest(); -$data->setEmailAddress("john@example.com") - ->setSignatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestUpdate($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestUpdate.py b/examples/SignatureRequestUpdate.py deleted file mode 100644 index 369000092..000000000 --- a/examples/SignatureRequestUpdate.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestUpdateRequest( - email_address="john@example.com", - signature_id="78caf2a1d01cd39cea2bc1cbb340dac3", - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_update( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestUpdate.rb b/examples/SignatureRequestUpdate.rb deleted file mode 100644 index 8294a4410..000000000 --- a/examples/SignatureRequestUpdate.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestUpdateRequest.new -data.email_address = "john@example.com" -data.signature_id = "78caf2a1d01cd39cea2bc1cbb340dac3" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_update(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestUpdate.ts b/examples/SignatureRequestUpdate.ts deleted file mode 100644 index 61a7c7466..000000000 --- a/examples/SignatureRequestUpdate.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.SignatureRequestUpdateRequest = { - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestUpdateExample.cs b/examples/SignatureRequestUpdateExample.cs new file mode 100644 index 000000000..7d9551620 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest( + signatureId: "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestUpdate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestUpdateRequest: signatureRequestUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestUpdateExample.java b/examples/SignatureRequestUpdateExample.java new file mode 100644 index 000000000..ef9873326 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestUpdateExample.php b/examples/SignatureRequestUpdateExample.php new file mode 100644 index 000000000..818add598 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_update_request = (new Dropbox\Sign\Model\SignatureRequestUpdateRequest()) + ->setSignatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f") + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestUpdate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request: $signature_request_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestUpdate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestUpdateExample.py b/examples/SignatureRequestUpdateExample.py new file mode 100644 index 000000000..0d9bc45fb --- /dev/null +++ b/examples/SignatureRequestUpdateExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_update_request = models.SignatureRequestUpdateRequest( + signature_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_update( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request=signature_request_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_update: %s\n" % e) diff --git a/examples/SignatureRequestUpdateExample.rb b/examples/SignatureRequestUpdateExample.rb new file mode 100644 index 000000000..3cac8ae67 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_update_request = Dropbox::Sign::SignatureRequestUpdateRequest.new +signature_request_update_request.signature_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +signature_request_update_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_update( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}" +end diff --git a/examples/SignatureRequestUpdate.sh b/examples/SignatureRequestUpdateExample.sh similarity index 100% rename from examples/SignatureRequestUpdate.sh rename to examples/SignatureRequestUpdateExample.sh diff --git a/examples/SignatureRequestUpdateExample.ts b/examples/SignatureRequestUpdateExample.ts new file mode 100644 index 000000000..fa02e0345 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestUpdateRequest = new models.SignatureRequestUpdateRequest(); +signatureRequestUpdateRequest.signatureId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +signatureRequestUpdateRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestUpdate:"); + console.log(error.body); +}); diff --git a/examples/TeamAddMember.cs b/examples/TeamAddMember.cs deleted file mode 100644 index 515014d8d..000000000 --- a/examples/TeamAddMember.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamAddMemberRequest( - emailAddress: "george@example.com" - ); - - try - { - var result = teamApi.TeamAddMember(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/examples/TeamAddMember.java b/examples/TeamAddMember.java deleted file mode 100644 index 454820932..000000000 --- a/examples/TeamAddMember.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamAddMemberRequest() - .emailAddress("george@example.com"); - - String teamId = null; - - try { - TeamGetResponse result = teamApi.teamAddMember(data, teamId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamAddMember.js b/examples/TeamAddMember.js deleted file mode 100644 index eaa69ade3..000000000 --- a/examples/TeamAddMember.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@example.com", -}; - -const result = teamApi.teamAddMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamAddMember.php b/examples/TeamAddMember.php deleted file mode 100644 index 7247c83ed..000000000 --- a/examples/TeamAddMember.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamAddMemberRequest(); -$data->setEmailAddress("george@example.com"); - -try { - $result = $teamApi->teamAddMember($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamAddMember.py b/examples/TeamAddMember.py deleted file mode 100644 index 67900f458..000000000 --- a/examples/TeamAddMember.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamAddMemberRequest( - email_address="george@example.com", - ) - - try: - response = team_api.team_add_member(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamAddMember.rb b/examples/TeamAddMember.rb deleted file mode 100644 index 34b41e33c..000000000 --- a/examples/TeamAddMember.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamAddMemberRequest.new -data.email_address = "george@example.com" - -begin - result = team_api.team_add_member(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamAddMember.ts b/examples/TeamAddMember.ts deleted file mode 100644 index 8e84f240f..000000000 --- a/examples/TeamAddMember.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamAddMemberRequest = { - emailAddress: "george@example.com", -}; - -const result = teamApi.teamAddMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamAddMemberAccountIdExample.cs b/examples/TeamAddMemberAccountIdExample.cs new file mode 100644 index 000000000..fe700fca7 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamAddMemberAccountIdExample.java b/examples/TeamAddMemberAccountIdExample.java new file mode 100644 index 000000000..cdeea5ec5 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamAddMemberAccountIdExample.php b/examples/TeamAddMemberAccountIdExample.php new file mode 100644 index 000000000..f864f4437 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/examples/TeamAddMemberAccountIdExample.py b/examples/TeamAddMemberAccountIdExample.py new file mode 100644 index 000000000..402e0f2c5 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/examples/TeamAddMemberAccountIdExample.rb b/examples/TeamAddMemberAccountIdExample.rb new file mode 100644 index 000000000..e19955860 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35" + +begin + response = Dropbox::Sign::TeamApi.new.team_add_member( + team_add_member_request, + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_add_member: #{e}" +end diff --git a/examples/TeamAddMemberAccountIdExample.ts b/examples/TeamAddMemberAccountIdExample.ts new file mode 100644 index 000000000..6aedbc340 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/examples/TeamAddMemberExample.cs b/examples/TeamAddMemberExample.cs new file mode 100644 index 000000000..3529c6ee0 --- /dev/null +++ b/examples/TeamAddMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + emailAddress: "george@example.com" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamAddMemberExample.java b/examples/TeamAddMemberExample.java new file mode 100644 index 000000000..788cc3bd0 --- /dev/null +++ b/examples/TeamAddMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamAddMemberExample.php b/examples/TeamAddMemberExample.php new file mode 100644 index 000000000..441e34dbe --- /dev/null +++ b/examples/TeamAddMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setEmailAddress("george@example.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/examples/TeamAddMemberExample.py b/examples/TeamAddMemberExample.py new file mode 100644 index 000000000..caef04ea5 --- /dev/null +++ b/examples/TeamAddMemberExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + email_address="george@example.com", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/examples/TeamAddMemberExample.rb b/examples/TeamAddMemberExample.rb new file mode 100644 index 000000000..b312e9894 --- /dev/null +++ b/examples/TeamAddMemberExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.email_address = "george@example.com" + +begin + response = Dropbox::Sign::TeamApi.new.team_add_member( + team_add_member_request, + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_add_member: #{e}" +end diff --git a/examples/TeamAddMember.sh b/examples/TeamAddMemberExample.sh similarity index 100% rename from examples/TeamAddMember.sh rename to examples/TeamAddMemberExample.sh diff --git a/examples/TeamAddMemberExample.ts b/examples/TeamAddMemberExample.ts new file mode 100644 index 000000000..0ffde9292 --- /dev/null +++ b/examples/TeamAddMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.emailAddress = "george@example.com"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/examples/TeamCreate.cs b/examples/TeamCreate.cs deleted file mode 100644 index 78d0768be..000000000 --- a/examples/TeamCreate.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamCreateRequest( - name: "New Team Name" - ); - - try - { - var result = teamApi.TeamCreate(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/examples/TeamCreate.java b/examples/TeamCreate.java deleted file mode 100644 index 0ecf2f50d..000000000 --- a/examples/TeamCreate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamCreateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamCreate.js b/examples/TeamCreate.js deleted file mode 100644 index e8cb5486e..000000000 --- a/examples/TeamCreate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - name: "New Team Name" -}; - -const result = teamApi.teamCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamCreate.php b/examples/TeamCreate.php deleted file mode 100644 index 3abdac1c2..000000000 --- a/examples/TeamCreate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamCreateRequest(); -$data->setName("New Team Name"); - -try { - $result = $teamApi->teamCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamCreate.rb b/examples/TeamCreate.rb deleted file mode 100644 index b97bfa396..000000000 --- a/examples/TeamCreate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamCreateRequest.new -data.name = "New Team Name" - -begin - result = team_api.team_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamCreate.ts b/examples/TeamCreate.ts deleted file mode 100644 index 8ef337f86..000000000 --- a/examples/TeamCreate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamCreateRequest = { - name: "New Team Name" -}; - -const result = teamApi.teamCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamCreateExample.cs b/examples/TeamCreateExample.cs new file mode 100644 index 000000000..794c4627d --- /dev/null +++ b/examples/TeamCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamCreateRequest = new TeamCreateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamCreate( + teamCreateRequest: teamCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamCreateExample.java b/examples/TeamCreateExample.java new file mode 100644 index 000000000..0b72d53e2 --- /dev/null +++ b/examples/TeamCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamCreateExample.php b/examples/TeamCreateExample.php new file mode 100644 index 000000000..aabcac028 --- /dev/null +++ b/examples/TeamCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_create_request = (new Dropbox\Sign\Model\TeamCreateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamCreate( + team_create_request: $team_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamCreate: {$e->getMessage()}"; +} diff --git a/examples/TeamUpdate.py b/examples/TeamCreateExample.py similarity index 52% rename from examples/TeamUpdate.py rename to examples/TeamCreateExample.py index b89ef1135..88772104e 100644 --- a/examples/TeamUpdate.py +++ b/examples/TeamCreateExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamUpdateRequest( + team_create_request = models.TeamCreateRequest( name="New Team Name", ) try: - response = team_api.team_update(data) + response = api.TeamApi(api_client).team_create( + team_create_request=team_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_create: %s\n" % e) diff --git a/examples/TeamCreateExample.rb b/examples/TeamCreateExample.rb new file mode 100644 index 000000000..6bac61268 --- /dev/null +++ b/examples/TeamCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_create_request = Dropbox::Sign::TeamCreateRequest.new +team_create_request.name = "New Team Name" + +begin + response = Dropbox::Sign::TeamApi.new.team_create( + team_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_create: #{e}" +end diff --git a/examples/TeamCreate.sh b/examples/TeamCreateExample.sh similarity index 100% rename from examples/TeamCreate.sh rename to examples/TeamCreateExample.sh diff --git a/examples/TeamCreateExample.ts b/examples/TeamCreateExample.ts new file mode 100644 index 000000000..22ad05f83 --- /dev/null +++ b/examples/TeamCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamCreateRequest = new models.TeamCreateRequest(); +teamCreateRequest.name = "New Team Name"; + +apiCaller.teamCreate( + teamCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamCreate:"); + console.log(error.body); +}); diff --git a/examples/TeamDelete.cs b/examples/TeamDelete.cs deleted file mode 100644 index 35eca42ff..000000000 --- a/examples/TeamDelete.cs +++ /dev/null @@ -1,31 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - try - { - teamApi.TeamDelete(); - } - 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/TeamDelete.java b/examples/TeamDelete.java deleted file mode 100644 index 9f09ef6d3..000000000 --- a/examples/TeamDelete.java +++ /dev/null @@ -1,29 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - teamApi.teamDelete(); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamDelete.js b/examples/TeamDelete.js deleted file mode 100644 index b211e14a3..000000000 --- a/examples/TeamDelete.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamDelete(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamDelete.php b/examples/TeamDelete.php deleted file mode 100644 index 327fec0a6..000000000 --- a/examples/TeamDelete.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $teamApi->teamDelete(); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamDelete.rb b/examples/TeamDelete.rb deleted file mode 100644 index 336f3bad4..000000000 --- a/examples/TeamDelete.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -begin - result = team_api.team_delete - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamDelete.ts b/examples/TeamDelete.ts deleted file mode 100644 index b211e14a3..000000000 --- a/examples/TeamDelete.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamDelete(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxDelete.cs b/examples/TeamDeleteExample.cs similarity index 58% rename from examples/FaxDelete.cs rename to examples/TeamDeleteExample.cs index 88a6ed074..b5c7a83b4 100644 --- a/examples/FaxDelete.cs +++ b/examples/TeamDeleteExample.cs @@ -1,26 +1,29 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - - var faxApi = new FaxApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + new TeamApi(config).TeamDelete(); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/TeamDeleteExample.java b/examples/TeamDeleteExample.java new file mode 100644 index 000000000..f39d1324c --- /dev/null +++ b/examples/TeamDeleteExample.java @@ -0,0 +1,36 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TeamApi(config).teamDelete(); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamDeleteExample.php b/examples/TeamDeleteExample.php new file mode 100644 index 000000000..9c429b748 --- /dev/null +++ b/examples/TeamDeleteExample.php @@ -0,0 +1,18 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TeamApi(config: $config))->teamDelete(); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamDelete: {$e->getMessage()}"; +} diff --git a/examples/TeamDelete.py b/examples/TeamDeleteExample.py similarity index 50% rename from examples/TeamDelete.py rename to examples/TeamDeleteExample.py index 9548749c7..2da2f0be7 100644 --- a/examples/TeamDelete.py +++ b/examples/TeamDeleteExample.py @@ -1,16 +1,16 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - team_api.team_delete() + api.TeamApi(api_client).team_delete() except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_delete: %s\n" % e) diff --git a/examples/TeamDeleteExample.rb b/examples/TeamDeleteExample.rb new file mode 100644 index 000000000..729b6f794 --- /dev/null +++ b/examples/TeamDeleteExample.rb @@ -0,0 +1,13 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::TeamApi.new.team_delete +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_delete: #{e}" +end diff --git a/examples/TeamDelete.sh b/examples/TeamDeleteExample.sh similarity index 100% rename from examples/TeamDelete.sh rename to examples/TeamDeleteExample.sh diff --git a/examples/TeamDeleteExample.ts b/examples/TeamDeleteExample.ts new file mode 100644 index 000000000..c37216b0c --- /dev/null +++ b/examples/TeamDeleteExample.ts @@ -0,0 +1,12 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamDelete().catch(error => { + console.log("Exception when calling TeamApi#teamDelete:"); + console.log(error.body); +}); diff --git a/examples/TeamGet.cs b/examples/TeamGet.cs deleted file mode 100644 index f1984f536..000000000 --- a/examples/TeamGet.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - try - { - var result = teamApi.TeamGet(); - 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/TeamGet.java b/examples/TeamGet.java deleted file mode 100644 index 035014b86..000000000 --- a/examples/TeamGet.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetResponse result = teamApi.teamGet(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamGet.js b/examples/TeamGet.js deleted file mode 100644 index dd1fc78da..000000000 --- a/examples/TeamGet.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamGet(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamGet.php b/examples/TeamGet.php deleted file mode 100644 index ccd714dad..000000000 --- a/examples/TeamGet.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $result = $teamApi->teamGet(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamGet.rb b/examples/TeamGet.rb deleted file mode 100644 index 7f3048844..000000000 --- a/examples/TeamGet.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -begin - result = team_api.team_get - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamGet.ts b/examples/TeamGet.ts deleted file mode 100644 index dd1fc78da..000000000 --- a/examples/TeamGet.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamGet(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAreaCodeGet.cs b/examples/TeamGetExample.cs similarity index 55% rename from examples/FaxLineAreaCodeGet.cs rename to examples/TeamGetExample.cs index 3beedfef1..3a79cd2a4 100644 --- a/examples/FaxLineAreaCodeGet.cs +++ b/examples/TeamGetExample.cs @@ -1,27 +1,31 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = faxLineApi.FaxLineAreaCodeGet("US", "CA"); - Console.WriteLine(result); + var response = new TeamApi(config).TeamGet(); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/TeamGetExample.java b/examples/TeamGetExample.java new file mode 100644 index 000000000..4356bb8a9 --- /dev/null +++ b/examples/TeamGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamGetExample.php b/examples/TeamGetExample.php new file mode 100644 index 000000000..79c6e054d --- /dev/null +++ b/examples/TeamGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamGet: {$e->getMessage()}"; +} diff --git a/examples/TeamGet.py b/examples/TeamGetExample.py similarity index 54% rename from examples/TeamGet.py rename to examples/TeamGetExample.py index 7272e46f3..dc0b0532e 100644 --- a/examples/TeamGet.py +++ b/examples/TeamGetExample.py @@ -1,19 +1,18 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_get() + response = api.TeamApi(api_client).team_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_get: %s\n" % e) diff --git a/examples/TeamGetExample.rb b/examples/TeamGetExample.rb new file mode 100644 index 000000000..903822830 --- /dev/null +++ b/examples/TeamGetExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_get + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_get: #{e}" +end diff --git a/examples/TeamGet.sh b/examples/TeamGetExample.sh similarity index 100% rename from examples/TeamGet.sh rename to examples/TeamGetExample.sh diff --git a/examples/TeamGetExample.ts b/examples/TeamGetExample.ts new file mode 100644 index 000000000..65d8758fc --- /dev/null +++ b/examples/TeamGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamGet:"); + console.log(error.body); +}); diff --git a/examples/TeamInfo.cs b/examples/TeamInfo.cs deleted file mode 100644 index 284dcdfed..000000000 --- a/examples/TeamInfo.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - try - { - var result = teamApi.TeamInfo(); - 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/TeamInfo.java b/examples/TeamInfo.java deleted file mode 100644 index 94ace0c38..000000000 --- a/examples/TeamInfo.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetInfoResponse result = teamApi.teamInfo(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamInfo"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamInfo.js b/examples/TeamInfo.js deleted file mode 100644 index 0e03b0f70..000000000 --- a/examples/TeamInfo.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamInfo(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInfo.php b/examples/TeamInfo.php deleted file mode 100644 index e43c06b72..000000000 --- a/examples/TeamInfo.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $result = $teamApi->teamInfo(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamInfo.rb b/examples/TeamInfo.rb deleted file mode 100644 index a7435f0c7..000000000 --- a/examples/TeamInfo.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -begin - result = team_api.team_info - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamInfo.ts b/examples/TeamInfo.ts deleted file mode 100644 index 0e03b0f70..000000000 --- a/examples/TeamInfo.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamInfo(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInfoExample.cs b/examples/TeamInfoExample.cs new file mode 100644 index 000000000..a761bce3c --- /dev/null +++ b/examples/TeamInfoExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInfoExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInfo( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInfo: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamInfoExample.java b/examples/TeamInfoExample.java new file mode 100644 index 000000000..8b5718628 --- /dev/null +++ b/examples/TeamInfoExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInfoExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamInfoExample.php b/examples/TeamInfoExample.php new file mode 100644 index 000000000..c908d5182 --- /dev/null +++ b/examples/TeamInfoExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInfo( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInfo: {$e->getMessage()}"; +} diff --git a/examples/TeamInfoExample.py b/examples/TeamInfoExample.py new file mode 100644 index 000000000..994688dc2 --- /dev/null +++ b/examples/TeamInfoExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_info( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_info: %s\n" % e) diff --git a/examples/TeamInfoExample.rb b/examples/TeamInfoExample.rb new file mode 100644 index 000000000..dfe5874d5 --- /dev/null +++ b/examples/TeamInfoExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_info( + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_info: #{e}" +end diff --git a/examples/TeamInfo.sh b/examples/TeamInfoExample.sh similarity index 100% rename from examples/TeamInfo.sh rename to examples/TeamInfoExample.sh diff --git a/examples/TeamInfoExample.ts b/examples/TeamInfoExample.ts new file mode 100644 index 000000000..d0050e94c --- /dev/null +++ b/examples/TeamInfoExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInfo:"); + console.log(error.body); +}); diff --git a/examples/TeamInvites.cs b/examples/TeamInvites.cs deleted file mode 100644 index b52c3b1c5..000000000 --- a/examples/TeamInvites.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var emailAddress = "user@dropboxsign.com"; - - try - { - var result = teamApi.TeamInvites(emailAddress); - 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/TeamInvites.java b/examples/TeamInvites.java deleted file mode 100644 index 56b517b17..000000000 --- a/examples/TeamInvites.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var emailAddress = "user@dropboxsign.com"; - - try { - TeamInvitesResponse result = teamApi.teamInvites(emailAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamInvites.js b/examples/TeamInvites.js deleted file mode 100644 index 21a250156..000000000 --- a/examples/TeamInvites.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const emailAddress = "user@dropboxsign.com"; - -const result = teamApi.teamInvites(emailAddress); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInvites.php b/examples/TeamInvites.php deleted file mode 100644 index 2cda1469d..000000000 --- a/examples/TeamInvites.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$emailAddress = "user@dropboxsign.com"; - -try { - $result = $teamApi->teamInvites($emailAddress); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamInvites.py b/examples/TeamInvites.py deleted file mode 100644 index 898e64187..000000000 --- a/examples/TeamInvites.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - email_address = "user@dropboxsign.com" - - try: - response = team_api.team_invites(email_address=email_address) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamInvites.rb b/examples/TeamInvites.rb deleted file mode 100644 index 7294ea425..000000000 --- a/examples/TeamInvites.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -email_address = "user@dropboxsign.com" - -begin - result = team_api.team_invites({ email_address: email_address }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamInvites.ts b/examples/TeamInvites.ts deleted file mode 100644 index 21a250156..000000000 --- a/examples/TeamInvites.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const emailAddress = "user@dropboxsign.com"; - -const result = teamApi.teamInvites(emailAddress); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInvitesExample.cs b/examples/TeamInvitesExample.cs new file mode 100644 index 000000000..90454cbac --- /dev/null +++ b/examples/TeamInvitesExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInvitesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInvites(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInvites: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamInvitesExample.java b/examples/TeamInvitesExample.java new file mode 100644 index 000000000..204109825 --- /dev/null +++ b/examples/TeamInvitesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInvitesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInvites"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamInvitesExample.php b/examples/TeamInvitesExample.php new file mode 100644 index 000000000..db9459376 --- /dev/null +++ b/examples/TeamInvitesExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInvites(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInvites: {$e->getMessage()}"; +} diff --git a/examples/FaxLineList.py b/examples/TeamInvitesExample.py similarity index 53% rename from examples/FaxLineList.py rename to examples/TeamInvitesExample.py index f868cd43c..c9764ae11 100644 --- a/examples/FaxLineList.py +++ b/examples/TeamInvitesExample.py @@ -1,17 +1,18 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_list() + response = api.TeamApi(api_client).team_invites() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_invites: %s\n" % e) diff --git a/examples/TeamInvitesExample.rb b/examples/TeamInvitesExample.rb new file mode 100644 index 000000000..9fee219c0 --- /dev/null +++ b/examples/TeamInvitesExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_invites + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_invites: #{e}" +end diff --git a/examples/TeamInvites.sh b/examples/TeamInvitesExample.sh similarity index 100% rename from examples/TeamInvites.sh rename to examples/TeamInvitesExample.sh diff --git a/examples/TeamInvitesExample.ts b/examples/TeamInvitesExample.ts new file mode 100644 index 000000000..7debb4877 --- /dev/null +++ b/examples/TeamInvitesExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInvites().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInvites:"); + console.log(error.body); +}); diff --git a/examples/TeamMembers.cs b/examples/TeamMembers.cs deleted file mode 100644 index 3426971cf..000000000 --- a/examples/TeamMembers.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - - try - { - var result = teamApi.TeamMembers(teamId); - 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/TeamMembers.java b/examples/TeamMembers.java deleted file mode 100644 index c3579567b..000000000 --- a/examples/TeamMembers.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamMembersResponse result = teamApi.teamMembers(teamId, page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamMembers.js b/examples/TeamMembers.js deleted file mode 100644 index eee5075cf..000000000 --- a/examples/TeamMembers.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamMembers(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamMembers.php b/examples/TeamMembers.php deleted file mode 100644 index 60128aa30..000000000 --- a/examples/TeamMembers.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -try { - $result = $teamApi->teamMembers($teamId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamMembers.py b/examples/TeamMembers.py deleted file mode 100644 index ed27ca884..000000000 --- a/examples/TeamMembers.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - - try: - response = team_api.team_members(team_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamMembers.rb b/examples/TeamMembers.rb deleted file mode 100644 index ce05cb2d7..000000000 --- a/examples/TeamMembers.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - -begin - result = team_api.team_members(team_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamMembers.ts b/examples/TeamMembers.ts deleted file mode 100644 index eee5075cf..000000000 --- a/examples/TeamMembers.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamMembers(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamMembersExample.cs b/examples/TeamMembersExample.cs new file mode 100644 index 000000000..72213f8a7 --- /dev/null +++ b/examples/TeamMembersExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamMembersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamMembers( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamMembers: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamMembersExample.java b/examples/TeamMembersExample.java new file mode 100644 index 000000000..bc709c951 --- /dev/null +++ b/examples/TeamMembersExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamMembersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamMembers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamMembersExample.php b/examples/TeamMembersExample.php new file mode 100644 index 000000000..79c0343b1 --- /dev/null +++ b/examples/TeamMembersExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamMembers( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamMembers: {$e->getMessage()}"; +} diff --git a/examples/TeamMembersExample.py b/examples/TeamMembersExample.py new file mode 100644 index 000000000..92c3ebaf5 --- /dev/null +++ b/examples/TeamMembersExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_members( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_members: %s\n" % e) diff --git a/examples/TeamMembersExample.rb b/examples/TeamMembersExample.rb new file mode 100644 index 000000000..f35f9d174 --- /dev/null +++ b/examples/TeamMembersExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_members( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_members: #{e}" +end diff --git a/examples/TeamMembers.sh b/examples/TeamMembersExample.sh similarity index 100% rename from examples/TeamMembers.sh rename to examples/TeamMembersExample.sh diff --git a/examples/TeamMembersExample.ts b/examples/TeamMembersExample.ts new file mode 100644 index 000000000..17479dbda --- /dev/null +++ b/examples/TeamMembersExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamMembers:"); + console.log(error.body); +}); diff --git a/examples/TeamRemoveMember.java b/examples/TeamRemoveMember.java deleted file mode 100644 index 28514c7ec..000000000 --- a/examples/TeamRemoveMember.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamRemoveMemberRequest() - .emailAddress("teammate@dropboxsign.com") - .newOwnerEmailAddress("new_teammate@dropboxsign.com"); - - try { - TeamGetResponse result = teamApi.teamRemoveMember(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamRemoveMember.js b/examples/TeamRemoveMember.js deleted file mode 100644 index 291e6fadb..000000000 --- a/examples/TeamRemoveMember.js +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com", -}; - -const result = teamApi.teamRemoveMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamRemoveMember.php b/examples/TeamRemoveMember.php deleted file mode 100644 index 73ec2ae6c..000000000 --- a/examples/TeamRemoveMember.php +++ /dev/null @@ -1,26 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamRemoveMemberRequest(); -$data->setEmailAddress("teammate@dropboxsign.com") - ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); - -try { - $result = $teamApi->teamRemoveMember($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamRemoveMember.rb b/examples/TeamRemoveMember.rb deleted file mode 100644 index b2255ef4b..000000000 --- a/examples/TeamRemoveMember.rb +++ /dev/null @@ -1,22 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamRemoveMemberRequest.new -data.email_address = "teammate@dropboxsign.com" -data.new_owner_email_address = "new_teammate@dropboxsign.com" - -begin - result = team_api.team_remove_member(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamRemoveMember.ts b/examples/TeamRemoveMember.ts deleted file mode 100644 index b7ba4beac..000000000 --- a/examples/TeamRemoveMember.ts +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamRemoveMemberRequest = { - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com", -}; - -const result = teamApi.teamRemoveMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamRemoveMemberAccountIdExample.cs b/examples/TeamRemoveMemberAccountIdExample.cs new file mode 100644 index 000000000..0c6ae21a3 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamRemoveMemberAccountIdExample.java b/examples/TeamRemoveMemberAccountIdExample.java new file mode 100644 index 000000000..85c46ee65 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamRemoveMemberAccountIdExample.php b/examples/TeamRemoveMemberAccountIdExample.php new file mode 100644 index 000000000..90d902633 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/examples/TeamRemoveMemberAccountIdExample.py b/examples/TeamRemoveMemberAccountIdExample.py new file mode 100644 index 000000000..132ab54cb --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_remove_member_request = models.TeamRemoveMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) diff --git a/examples/TeamRemoveMemberAccountIdExample.rb b/examples/TeamRemoveMemberAccountIdExample.rb new file mode 100644 index 000000000..16913dd79 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new +team_remove_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35" + +begin + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_remove_member: #{e}" +end diff --git a/examples/TeamRemoveMemberAccountIdExample.ts b/examples/TeamRemoveMemberAccountIdExample.ts new file mode 100644 index 000000000..e170817b3 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/examples/TeamRemoveMember.cs b/examples/TeamRemoveMemberExample.cs similarity index 50% rename from examples/TeamRemoveMember.cs rename to examples/TeamRemoveMemberExample.cs index c4051b639..23aeff1ff 100644 --- a/examples/TeamRemoveMember.cs +++ b/examples/TeamRemoveMemberExample.cs @@ -1,35 +1,38 @@ using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamRemoveMemberRequest( + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( emailAddress: "teammate@dropboxsign.com", newOwnerEmailAddress: "new_teammate@dropboxsign.com" ); try { - var result = teamApi.TeamRemoveMember(data); - Console.WriteLine(result); + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/examples/TeamRemoveMemberExample.java b/examples/TeamRemoveMemberExample.java new file mode 100644 index 000000000..40938583f --- /dev/null +++ b/examples/TeamRemoveMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamRemoveMemberExample.php b/examples/TeamRemoveMemberExample.php new file mode 100644 index 000000000..3212aa335 --- /dev/null +++ b/examples/TeamRemoveMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setEmailAddress("teammate@dropboxsign.com") + ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/examples/TeamRemoveMember.py b/examples/TeamRemoveMemberExample.py similarity index 55% rename from examples/TeamRemoveMember.py rename to examples/TeamRemoveMemberExample.py index 5dfe5b0bf..7847d7289 100644 --- a/examples/TeamRemoveMember.py +++ b/examples/TeamRemoveMemberExample.py @@ -1,24 +1,25 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamRemoveMemberRequest( + team_remove_member_request = models.TeamRemoveMemberRequest( email_address="teammate@dropboxsign.com", new_owner_email_address="new_teammate@dropboxsign.com", ) try: - response = team_api.team_remove_member(data) + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) diff --git a/examples/TeamRemoveMemberExample.rb b/examples/TeamRemoveMemberExample.rb new file mode 100644 index 000000000..27c87cb0e --- /dev/null +++ b/examples/TeamRemoveMemberExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new +team_remove_member_request.email_address = "teammate@dropboxsign.com" +team_remove_member_request.new_owner_email_address = "new_teammate@dropboxsign.com" + +begin + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_remove_member: #{e}" +end diff --git a/examples/TeamRemoveMember.sh b/examples/TeamRemoveMemberExample.sh similarity index 100% rename from examples/TeamRemoveMember.sh rename to examples/TeamRemoveMemberExample.sh diff --git a/examples/TeamRemoveMemberExample.ts b/examples/TeamRemoveMemberExample.ts new file mode 100644 index 000000000..efd33d694 --- /dev/null +++ b/examples/TeamRemoveMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.emailAddress = "teammate@dropboxsign.com"; +teamRemoveMemberRequest.newOwnerEmailAddress = "new_teammate@dropboxsign.com"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/examples/TeamSubTeams.cs b/examples/TeamSubTeams.cs deleted file mode 100644 index cab5c691f..000000000 --- a/examples/TeamSubTeams.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - - try - { - var result = teamApi.TeamSubTeams(teamId); - 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/TeamSubTeams.java b/examples/TeamSubTeams.java deleted file mode 100644 index f4a5b50e5..000000000 --- a/examples/TeamSubTeams.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamSubTeamsResponse result = teamApi.teamSubTeams(teamId, page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamSubTeams"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamSubTeams.js b/examples/TeamSubTeams.js deleted file mode 100644 index faf7a9ea6..000000000 --- a/examples/TeamSubTeams.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamSubTeams(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamSubTeams.php b/examples/TeamSubTeams.php deleted file mode 100644 index 8daf498e2..000000000 --- a/examples/TeamSubTeams.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -try { - $result = $teamApi->teamSubTeams($teamId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamSubTeams.py b/examples/TeamSubTeams.py deleted file mode 100644 index d6f7dc183..000000000 --- a/examples/TeamSubTeams.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - - try: - response = team_api.team_sub_teams(team_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamSubTeams.rb b/examples/TeamSubTeams.rb deleted file mode 100644 index 94192cdff..000000000 --- a/examples/TeamSubTeams.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - -begin - result = team_api.team_sub_teams(team_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamSubTeams.ts b/examples/TeamSubTeams.ts deleted file mode 100644 index faf7a9ea6..000000000 --- a/examples/TeamSubTeams.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamSubTeams(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamSubTeamsExample.cs b/examples/TeamSubTeamsExample.cs new file mode 100644 index 000000000..1760310a5 --- /dev/null +++ b/examples/TeamSubTeamsExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamSubTeamsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamSubTeams( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamSubTeams: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamSubTeamsExample.java b/examples/TeamSubTeamsExample.java new file mode 100644 index 000000000..f0ee98cf1 --- /dev/null +++ b/examples/TeamSubTeamsExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamSubTeamsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamSubTeams"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamSubTeamsExample.php b/examples/TeamSubTeamsExample.php new file mode 100644 index 000000000..ae7a990e2 --- /dev/null +++ b/examples/TeamSubTeamsExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamSubTeams( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamSubTeams: {$e->getMessage()}"; +} diff --git a/examples/TeamSubTeamsExample.py b/examples/TeamSubTeamsExample.py new file mode 100644 index 000000000..93afde113 --- /dev/null +++ b/examples/TeamSubTeamsExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_sub_teams( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_sub_teams: %s\n" % e) diff --git a/examples/TeamSubTeamsExample.rb b/examples/TeamSubTeamsExample.rb new file mode 100644 index 000000000..12c87f2b7 --- /dev/null +++ b/examples/TeamSubTeamsExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_sub_teams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_sub_teams: #{e}" +end diff --git a/examples/TeamSubTeams.sh b/examples/TeamSubTeamsExample.sh similarity index 100% rename from examples/TeamSubTeams.sh rename to examples/TeamSubTeamsExample.sh diff --git a/examples/TeamSubTeamsExample.ts b/examples/TeamSubTeamsExample.ts new file mode 100644 index 000000000..e6ef9c8da --- /dev/null +++ b/examples/TeamSubTeamsExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamSubTeams:"); + console.log(error.body); +}); diff --git a/examples/TeamUpdate.cs b/examples/TeamUpdate.cs deleted file mode 100644 index f31b538a5..000000000 --- a/examples/TeamUpdate.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamUpdateRequest( - name: "New Team Name" - ); - - try - { - var result = teamApi.TeamUpdate(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/examples/TeamUpdate.java b/examples/TeamUpdate.java deleted file mode 100644 index eedcafc71..000000000 --- a/examples/TeamUpdate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamUpdateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamUpdate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamUpdate.js b/examples/TeamUpdate.js deleted file mode 100644 index 842457d4c..000000000 --- a/examples/TeamUpdate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - name: "New Team Name", -}; - -const result = teamApi.teamUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamUpdate.php b/examples/TeamUpdate.php deleted file mode 100644 index 6bac87d66..000000000 --- a/examples/TeamUpdate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamUpdateRequest(); -$data->setName("New Team Name"); - -try { - $result = $teamApi->teamUpdate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamUpdate.rb b/examples/TeamUpdate.rb deleted file mode 100644 index 27edefa90..000000000 --- a/examples/TeamUpdate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamUpdateRequest.new -data.name = "New Team Name" - -begin - result = team_api.team_update(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamUpdate.ts b/examples/TeamUpdate.ts deleted file mode 100644 index 73eac24a6..000000000 --- a/examples/TeamUpdate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamUpdateRequest = { - name: "New Team Name", -}; - -const result = teamApi.teamUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamUpdateExample.cs b/examples/TeamUpdateExample.cs new file mode 100644 index 000000000..355811ee4 --- /dev/null +++ b/examples/TeamUpdateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamUpdateRequest = new TeamUpdateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamUpdate( + teamUpdateRequest: teamUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamUpdateExample.java b/examples/TeamUpdateExample.java new file mode 100644 index 000000000..54f6bf2a1 --- /dev/null +++ b/examples/TeamUpdateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamUpdateExample.php b/examples/TeamUpdateExample.php new file mode 100644 index 000000000..3338af6e6 --- /dev/null +++ b/examples/TeamUpdateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_update_request = (new Dropbox\Sign\Model\TeamUpdateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamUpdate( + team_update_request: $team_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamUpdate: {$e->getMessage()}"; +} diff --git a/examples/TeamCreate.py b/examples/TeamUpdateExample.py similarity index 52% rename from examples/TeamCreate.py rename to examples/TeamUpdateExample.py index 4c1384681..e28eb2907 100644 --- a/examples/TeamCreate.py +++ b/examples/TeamUpdateExample.py @@ -1,23 +1,24 @@ +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamCreateRequest( + team_update_request = models.TeamUpdateRequest( name="New Team Name", ) try: - response = team_api.team_create(data) + response = api.TeamApi(api_client).team_update( + team_update_request=team_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_update: %s\n" % e) diff --git a/examples/TeamUpdateExample.rb b/examples/TeamUpdateExample.rb new file mode 100644 index 000000000..7f925ffff --- /dev/null +++ b/examples/TeamUpdateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_update_request = Dropbox::Sign::TeamUpdateRequest.new +team_update_request.name = "New Team Name" + +begin + response = Dropbox::Sign::TeamApi.new.team_update( + team_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_update: #{e}" +end diff --git a/examples/TeamUpdate.sh b/examples/TeamUpdateExample.sh similarity index 100% rename from examples/TeamUpdate.sh rename to examples/TeamUpdateExample.sh diff --git a/examples/TeamUpdateExample.ts b/examples/TeamUpdateExample.ts new file mode 100644 index 000000000..0e32bcdd4 --- /dev/null +++ b/examples/TeamUpdateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamUpdateRequest = new models.TeamUpdateRequest(); +teamUpdateRequest.name = "New Team Name"; + +apiCaller.teamUpdate( + teamUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamUpdate:"); + console.log(error.body); +}); diff --git a/examples/TemplateAddUser.cs b/examples/TemplateAddUser.cs deleted file mode 100644 index 23d85c8c1..000000000 --- a/examples/TemplateAddUser.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - var data = new TemplateAddUserRequest( - emailAddress: "george@dropboxsign.com" - ); - - try - { - var result = templateApi.TemplateAddUser(templateId, 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/examples/TemplateAddUser.java b/examples/TemplateAddUser.java deleted file mode 100644 index 759990b4c..000000000 --- a/examples/TemplateAddUser.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateAddUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateAddUser(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateAddUser.js b/examples/TemplateAddUser.js deleted file mode 100644 index 1b53fa3e2..000000000 --- a/examples/TemplateAddUser.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateAddUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateAddUser.php b/examples/TemplateAddUser.php deleted file mode 100644 index 2bbc31885..000000000 --- a/examples/TemplateAddUser.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateAddUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateAddUser($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateAddUser.py b/examples/TemplateAddUser.py deleted file mode 100644 index 5476f8e8b..000000000 --- a/examples/TemplateAddUser.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateAddUserRequest( - email_address="george@dropboxsign.com", - ) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_add_user(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateAddUser.rb b/examples/TemplateAddUser.rb deleted file mode 100644 index 89573c390..000000000 --- a/examples/TemplateAddUser.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateAddUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "f57db65d3f933b5316d398057a36176831451a35" - -begin - result = template_api.template_add_user(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateAddUser.ts b/examples/TemplateAddUser.ts deleted file mode 100644 index 6919a088d..000000000 --- a/examples/TemplateAddUser.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateAddUserRequest = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateAddUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateAddUserExample.cs b/examples/TemplateAddUserExample.cs new file mode 100644 index 000000000..dc4107a2f --- /dev/null +++ b/examples/TemplateAddUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateAddUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateAddUserRequest = new TemplateAddUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateAddUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateAddUserRequest: templateAddUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateAddUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateAddUserExample.java b/examples/TemplateAddUserExample.java new file mode 100644 index 000000000..144cb00ef --- /dev/null +++ b/examples/TemplateAddUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateAddUserExample.php b/examples/TemplateAddUserExample.php new file mode 100644 index 000000000..a76613a1d --- /dev/null +++ b/examples/TemplateAddUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_add_user_request = (new Dropbox\Sign\Model\TemplateAddUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateAddUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request: $template_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateAddUser: {$e->getMessage()}"; +} diff --git a/examples/TemplateAddUserExample.py b/examples/TemplateAddUserExample.py new file mode 100644 index 000000000..5259a01d4 --- /dev/null +++ b/examples/TemplateAddUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_add_user_request = models.TemplateAddUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_add_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request=template_add_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_add_user: %s\n" % e) diff --git a/examples/TemplateAddUserExample.rb b/examples/TemplateAddUserExample.rb new file mode 100644 index 000000000..a34a81fbf --- /dev/null +++ b/examples/TemplateAddUserExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_add_user_request = Dropbox::Sign::TemplateAddUserRequest.new +template_add_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_add_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_add_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_add_user: #{e}" +end diff --git a/examples/TemplateAddUser.sh b/examples/TemplateAddUserExample.sh similarity index 100% rename from examples/TemplateAddUser.sh rename to examples/TemplateAddUserExample.sh diff --git a/examples/TemplateAddUserExample.ts b/examples/TemplateAddUserExample.ts new file mode 100644 index 000000000..f801c3e65 --- /dev/null +++ b/examples/TemplateAddUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateAddUserRequest = new models.TemplateAddUserRequest(); +templateAddUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateAddUser:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreate.cs b/examples/TemplateCreate.cs deleted file mode 100644 index cce736293..000000000 --- a/examples/TemplateCreate.cs +++ /dev/null @@ -1,79 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var role1 = new SubTemplateRole( - name: "Client", - order: 0 - ); - - var role2 = new SubTemplateRole( - name: "Witness", - order: 1 - ); - - var mergeField1 = new SubMergeField( - name: "Full Name", - type: SubMergeField.TypeEnum.Text - ); - - var mergeField2 = new SubMergeField( - name: "Is Registered?", - type: SubMergeField.TypeEnum.Checkbox - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateCreateRequest( - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: files, - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: new List(){role1, role2}, - ccRoles: new List(){"Manager"}, - mergeFields: new List(){mergeField1, mergeField2}, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = templateApi.TemplateCreate(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/examples/TemplateCreate.java b/examples/TemplateCreate.java deleted file mode 100644 index f2cd5990b..000000000 --- a/examples/TemplateCreate.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateResponse result = templateApi.templateCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateCreate.js b/examples/TemplateCreate.js deleted file mode 100644 index f71d247e1..000000000 --- a/examples/TemplateCreate.js +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1 = { - name: "Client", - order: 0, -}; - -const role2 = { - name: "Witness", - order: 1, -}; - -const mergeField1 = { - name: "Full Name", - type: "text", -}; - -const mergeField2 = { - name: "Is Registered?", - type: "checkbox", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreate.php b/examples/TemplateCreate.php deleted file mode 100644 index 7b1b866f2..000000000 --- a/examples/TemplateCreate.php +++ /dev/null @@ -1,53 +0,0 @@ -setUsername('YOUR_API_KEY'); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName('Client') - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName('Witness') - ->setOrder(1); - -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName('Full Name') - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); - -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName('Is Registered?') - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateRequest(); -$data->setClientId('37dee8d8440c66d54cfa05d92c160882') - ->setFiles([new SplFileObject(__DIR__ . '/example_signature_request.pdf')]) - ->setTitle('Test Template') - ->setSubject('Please sign this document') - ->setMessage('For your approval') - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(['Manager']) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $templateApi->templateCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo 'Exception when calling Dropbox Sign API: ' - . print_r($error->getError()); -} diff --git a/examples/TemplateCreate.py b/examples/TemplateCreate.py deleted file mode 100644 index cb7b60e51..000000000 --- a/examples/TemplateCreate.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, - ) - - merge_field_1 = models.SubMergeField( - name="Full Name", - type="text", - ) - - merge_field_2 = models.SubMergeField( - name="Is Registered?", - type="checkbox", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.TemplateCreateRequest( - client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", - message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, - test_mode=True, - ) - - try: - response = template_api.template_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateCreate.rb b/examples/TemplateCreate.rb deleted file mode 100644 index 09863a2f2..000000000 --- a/examples/TemplateCreate.rb +++ /dev/null @@ -1,49 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -role_1 = Dropbox::Sign::SubTemplateRole.new -role_1.name = "Client" -role_1.order = 0 - -role_2 = Dropbox::Sign::SubTemplateRole.new -role_2.name = "Witness" -role_2.order = 1 - -merge_field_1 = Dropbox::Sign::SubMergeField.new -merge_field_1.name = "Full Name" -merge_field_1.type = "text" - -merge_field_2 = Dropbox::Sign::SubMergeField.new -merge_field_2.name = "Is Registered?" -merge_field_2.type = "checkbox" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::TemplateCreateRequest.new -data.client_id = "37dee8d8440c66d54cfa05d92c160882" -data.files = [File.new("example_signature_request.pdf", "r")] -data.title = "Test Template" -data.subject = "Please sign this document" -data.message = "For your approval" -data.signer_roles = [role_1, role_2] -data.cc_roles = ["Manager"] -data.merge_fields = [merge_field_1, merge_field_2] -data.field_options = field_options -data.test_mode = true - -begin - result = template_api.template_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateCreate.ts b/examples/TemplateCreate.ts deleted file mode 100644 index 2bcd3689e..000000000 --- a/examples/TemplateCreate.ts +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1: DropboxSign.SubTemplateRole = { - name: "Client", - order: 0, -}; - -const role2: DropboxSign.SubTemplateRole = { - name: "Witness", - order: 1, -}; - -const mergeField1: DropboxSign.SubMergeField = { - name: "Full Name", - type: DropboxSign.SubMergeField.TypeEnum.Text, -}; - -const mergeField2: DropboxSign.SubMergeField = { - name: "Is Registered?", - type: DropboxSign.SubMergeField.TypeEnum.Checkbox, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.TemplateCreateRequest = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreateEmbeddedDraft.cs b/examples/TemplateCreateEmbeddedDraft.cs deleted file mode 100644 index 42335ff90..000000000 --- a/examples/TemplateCreateEmbeddedDraft.cs +++ /dev/null @@ -1,79 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var role1 = new SubTemplateRole( - name: "Client", - order: 0 - ); - - var role2 = new SubTemplateRole( - name: "Witness", - order: 1 - ); - - var mergeField1 = new SubMergeField( - name: "Full Name", - type: SubMergeField.TypeEnum.Text - ); - - var mergeField2 = new SubMergeField( - name: "Is Registered?", - type: SubMergeField.TypeEnum.Checkbox - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateCreateEmbeddedDraftRequest( - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: files, - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: new List(){role1, role2}, - ccRoles: new List(){"Manager"}, - mergeFields: new List(){mergeField1, mergeField2}, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = templateApi.TemplateCreateEmbeddedDraft(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/examples/TemplateCreateEmbeddedDraft.java b/examples/TemplateCreateEmbeddedDraft.java deleted file mode 100644 index 7ae46b461..000000000 --- a/examples/TemplateCreateEmbeddedDraft.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateEmbeddedDraftRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateEmbeddedDraftResponse result = templateApi.templateCreateEmbeddedDraft(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateCreateEmbeddedDraft.js b/examples/TemplateCreateEmbeddedDraft.js deleted file mode 100644 index 1d8ba8741..000000000 --- a/examples/TemplateCreateEmbeddedDraft.js +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1 = { - name: "Client", - order: 0, -}; - -const role2 = { - name: "Witness", - order: 1, -}; - -const mergeField1 = { - name: "Full Name", - type: "text", -}; - -const mergeField2 = { - name: "Is Registered?", - type: "checkbox", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreateEmbeddedDraft(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreateEmbeddedDraft.php b/examples/TemplateCreateEmbeddedDraft.php deleted file mode 100644 index 4e1421b47..000000000 --- a/examples/TemplateCreateEmbeddedDraft.php +++ /dev/null @@ -1,53 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName("Client") - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName("Witness") - ->setOrder(1); - -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName("Full Name") - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); - -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName("Is Registered?") - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest(); -$data->setClientId("37dee8d8440c66d54cfa05d92c160882") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTitle("Test Template") - ->setSubject("Please sign this document") - ->setMessage("For your approval") - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(["Manager"]) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $templateApi->templateCreateEmbeddedDraft($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateCreateEmbeddedDraft.py b/examples/TemplateCreateEmbeddedDraft.py deleted file mode 100644 index 9b49f037c..000000000 --- a/examples/TemplateCreateEmbeddedDraft.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, - ) - - merge_field_1 = models.SubMergeField( - name="Full Name", - type="text", - ) - - merge_field_2 = models.SubMergeField( - name="Is Registered?", - type="checkbox", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.TemplateCreateEmbeddedDraftRequest( - client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", - message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, - test_mode=True, - ) - - try: - response = template_api.template_create_embedded_draft(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraft.rb b/examples/TemplateCreateEmbeddedDraft.rb deleted file mode 100644 index 6eb0f2750..000000000 --- a/examples/TemplateCreateEmbeddedDraft.rb +++ /dev/null @@ -1,49 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -role_1 = Dropbox::Sign::SubTemplateRole.new -role_1.name = "Client" -role_1.order = 0 - -role_2 = Dropbox::Sign::SubTemplateRole.new -role_2.name = "Witness" -role_2.order = 1 - -merge_field_1 = Dropbox::Sign::SubMergeField.new -merge_field_1.name = "Full Name" -merge_field_1.type = "text" - -merge_field_2 = Dropbox::Sign::SubMergeField.new -merge_field_2.name = "Is Registered?" -merge_field_2.type = "checkbox" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new -data.client_id = "37dee8d8440c66d54cfa05d92c160882" -data.files = [File.new("example_signature_request.pdf", "r")] -data.title = "Test Template" -data.subject = "Please sign this document" -data.message = "For your approval" -data.signer_roles = [role_1, role_2] -data.cc_roles = ["Manager"] -data.merge_fields = [merge_field_1, merge_field_2] -data.field_options = field_options -data.test_mode = true - -begin - result = template_api.template_create_embedded_draft(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateCreateEmbeddedDraft.ts b/examples/TemplateCreateEmbeddedDraft.ts deleted file mode 100644 index 960e8a65d..000000000 --- a/examples/TemplateCreateEmbeddedDraft.ts +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1: DropboxSign.SubTemplateRole = { - name: "Client", - order: 0, -}; - -const role2: DropboxSign.SubTemplateRole = { - name: "Witness", - order: 1, -}; - -const mergeField1: DropboxSign.SubMergeField = { - name: "Full Name", - type: DropboxSign.SubMergeField.TypeEnum.Text, -}; - -const mergeField2: DropboxSign.SubMergeField = { - name: "Is Registered?", - type: DropboxSign.SubMergeField.TypeEnum.Checkbox, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.TemplateCreateEmbeddedDraftRequest = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreateEmbeddedDraft(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreateEmbeddedDraftExample.cs b/examples/TemplateCreateEmbeddedDraftExample.cs new file mode 100644 index 000000000..e26574c52 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftExample.java b/examples/TemplateCreateEmbeddedDraftExample.java new file mode 100644 index 000000000..cb8c9ce12 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.java @@ -0,0 +1,85 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftExample.php b/examples/TemplateCreateEmbeddedDraftExample.php new file mode 100644 index 000000000..bf035f3cb --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.php @@ -0,0 +1,66 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftExample.py b/examples/TemplateCreateEmbeddedDraftExample.py new file mode 100644 index 000000000..2e96c0a48 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.py @@ -0,0 +1,71 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftExample.rb b/examples/TemplateCreateEmbeddedDraftExample.rb new file mode 100644 index 000000000..8d40c03a2 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.rb @@ -0,0 +1,62 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraft.sh b/examples/TemplateCreateEmbeddedDraftExample.sh similarity index 100% rename from examples/TemplateCreateEmbeddedDraft.sh rename to examples/TemplateCreateEmbeddedDraftExample.sh diff --git a/examples/TemplateCreateEmbeddedDraftExample.ts b/examples/TemplateCreateEmbeddedDraftExample.ts new file mode 100644 index 000000000..6371fcd18 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs new file mode 100644 index 000000000..2603e2c47 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java new file mode 100644 index 000000000..61c6fc967 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldGroups(formFieldGroups); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php new file mode 100644 index 000000000..120c310df --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py new file mode 100644 index 000000000..84232eacf --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb new file mode 100644 index 000000000..3cf7abbf2 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb @@ -0,0 +1,108 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_field_groups = form_field_groups +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts new file mode 100644 index 000000000..5bdb6384f --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldGroups = formFieldGroups; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs new file mode 100644 index 000000000..6d7a8e39b --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java new file mode 100644 index 000000000..7bb877263 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldRules(formFieldRules); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php new file mode 100644 index 000000000..5456b67fc --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py new file mode 100644 index 000000000..e20394052 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb new file mode 100644 index 000000000..38263c1cb --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb @@ -0,0 +1,124 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_field_rules = form_field_rules +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts new file mode 100644 index 000000000..ce20fc91d --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldRules = formFieldRules; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..cb3fd770d --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..38e8fccbc --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..6dc4c93c7 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..b99b91ac7 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..525ee3773 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..0ce2cbcd4 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateExample.cs b/examples/TemplateCreateExample.cs new file mode 100644 index 000000000..09fad4bd6 --- /dev/null +++ b/examples/TemplateCreateExample.cs @@ -0,0 +1,129 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateExample.java b/examples/TemplateCreateExample.java new file mode 100644 index 000000000..b8b8e5150 --- /dev/null +++ b/examples/TemplateCreateExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateExample.php b/examples/TemplateCreateExample.php new file mode 100644 index 000000000..93b6dedd0 --- /dev/null +++ b/examples/TemplateCreateExample.php @@ -0,0 +1,100 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateExample.py b/examples/TemplateCreateExample.py new file mode 100644 index 000000000..a6ed3611e --- /dev/null +++ b/examples/TemplateCreateExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateExample.rb b/examples/TemplateCreateExample.rb new file mode 100644 index 000000000..f4d623397 --- /dev/null +++ b/examples/TemplateCreateExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreate.sh b/examples/TemplateCreateExample.sh similarity index 100% rename from examples/TemplateCreate.sh rename to examples/TemplateCreateExample.sh diff --git a/examples/TemplateCreateExample.ts b/examples/TemplateCreateExample.ts new file mode 100644 index 000000000..c17b780a9 --- /dev/null +++ b/examples/TemplateCreateExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateFormFieldGroupsExample.cs b/examples/TemplateCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b8c56e791 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldGroups: formFieldGroups, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateFormFieldGroupsExample.java b/examples/TemplateCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..08612bd26 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldGroups(formFieldGroups); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateFormFieldGroupsExample.php b/examples/TemplateCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..1c0e02063 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldGroups($form_field_groups) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateFormFieldGroupsExample.py b/examples/TemplateCreateFormFieldGroupsExample.py new file mode 100644 index 000000000..6a755d022 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_groups=form_field_groups, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldGroupsExample.rb b/examples/TemplateCreateFormFieldGroupsExample.rb new file mode 100644 index 000000000..83fdc09bb --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.rb @@ -0,0 +1,108 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_groups = form_field_groups +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldGroupsExample.ts b/examples/TemplateCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..e12c74953 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldGroups = formFieldGroups; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateFormFieldRulesExample.cs b/examples/TemplateCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..6e2224ff4 --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldRules: formFieldRules, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateFormFieldRulesExample.java b/examples/TemplateCreateFormFieldRulesExample.java new file mode 100644 index 000000000..a3c621aee --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldRules(formFieldRules); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateFormFieldRulesExample.php b/examples/TemplateCreateFormFieldRulesExample.php new file mode 100644 index 000000000..74009f900 --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldRules($form_field_rules) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateFormFieldRulesExample.py b/examples/TemplateCreateFormFieldRulesExample.py new file mode 100644 index 000000000..a7f2d94ff --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_rules=form_field_rules, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldRulesExample.rb b/examples/TemplateCreateFormFieldRulesExample.rb new file mode 100644 index 000000000..cea893e1d --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.rb @@ -0,0 +1,124 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_rules = form_field_rules +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldRulesExample.ts b/examples/TemplateCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..31a949aea --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldRules = formFieldRules; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.cs b/examples/TemplateCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..503e80645 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.java b/examples/TemplateCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..397046a78 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.php b/examples/TemplateCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..a4f60e965 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.py b/examples/TemplateCreateFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..6e2185aa9 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.rb b/examples/TemplateCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..39185b3d0 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.ts b/examples/TemplateCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..d580e665b --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateDelete.cs b/examples/TemplateDelete.cs deleted file mode 100644 index 2740496cf..000000000 --- a/examples/TemplateDelete.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - templateApi.TemplateDelete(templateId); - } - 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/TemplateDelete.java b/examples/TemplateDelete.java deleted file mode 100644 index 0714a45d4..000000000 --- a/examples/TemplateDelete.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - templateApi.templateDelete(templateId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateDelete.js b/examples/TemplateDelete.js deleted file mode 100644 index a82580ff4..000000000 --- a/examples/TemplateDelete.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateDelete(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateDelete.php b/examples/TemplateDelete.php deleted file mode 100644 index 3858b7559..000000000 --- a/examples/TemplateDelete.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $templateApi->templateDelete($templateId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateDelete.py b/examples/TemplateDelete.py deleted file mode 100644 index c87622efa..000000000 --- a/examples/TemplateDelete.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - template_api.template_delete(template_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateDelete.rb b/examples/TemplateDelete.rb deleted file mode 100644 index cff67b421..000000000 --- a/examples/TemplateDelete.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_delete(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateDelete.ts b/examples/TemplateDelete.ts deleted file mode 100644 index a82580ff4..000000000 --- a/examples/TemplateDelete.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateDelete(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateDeleteExample.cs b/examples/TemplateDeleteExample.cs new file mode 100644 index 000000000..5a49ea03f --- /dev/null +++ b/examples/TemplateDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new TemplateApi(config).TemplateDelete( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateDeleteExample.java b/examples/TemplateDeleteExample.java new file mode 100644 index 000000000..b9d0b77ad --- /dev/null +++ b/examples/TemplateDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateDeleteExample.php b/examples/TemplateDeleteExample.php new file mode 100644 index 000000000..63c7a6a72 --- /dev/null +++ b/examples/TemplateDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateDelete( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateDelete: {$e->getMessage()}"; +} diff --git a/examples/TemplateDeleteExample.py b/examples/TemplateDeleteExample.py new file mode 100644 index 000000000..3bf63f5ad --- /dev/null +++ b/examples/TemplateDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.TemplateApi(api_client).template_delete( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + except ApiException as e: + print("Exception when calling TemplateApi#template_delete: %s\n" % e) diff --git a/examples/TemplateDeleteExample.rb b/examples/TemplateDeleteExample.rb new file mode 100644 index 000000000..33e07f299 --- /dev/null +++ b/examples/TemplateDeleteExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::TemplateApi.new.template_delete( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_delete: #{e}" +end diff --git a/examples/TemplateDelete.sh b/examples/TemplateDeleteExample.sh similarity index 100% rename from examples/TemplateDelete.sh rename to examples/TemplateDeleteExample.sh diff --git a/examples/TemplateDeleteExample.ts b/examples/TemplateDeleteExample.ts new file mode 100644 index 000000000..3f0aae438 --- /dev/null +++ b/examples/TemplateDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateDelete( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).catch(error => { + console.log("Exception when calling TemplateApi#templateDelete:"); + console.log(error.body); +}); diff --git a/examples/TemplateFiles.cs b/examples/TemplateFiles.cs deleted file mode 100644 index db4d641c7..000000000 --- a/examples/TemplateFiles.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateFiles(templateId, "pdf"); - - 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/TemplateFiles.java b/examples/TemplateFiles.java deleted file mode 100644 index 2c24e4827..000000000 --- a/examples/TemplateFiles.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - File result = templateApi.templateFiles(templateId, "pdf"); - result.renameTo(new File("file_response.pdf")); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateFiles.js b/examples/TemplateFiles.js deleted file mode 100644 index 00217b49b..000000000 --- a/examples/TemplateFiles.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; -const fileType = "pdf"; - -const result = templateApi.templateFiles(templateId, fileType); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFiles.php b/examples/TemplateFiles.php deleted file mode 100644 index e3e7341ee..000000000 --- a/examples/TemplateFiles.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; -$fileType = "pdf"; - -try { - $result = $templateApi->templateFiles($templateId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateFiles.py b/examples/TemplateFiles.py deleted file mode 100644 index 59874bc61..000000000 --- a/examples/TemplateFiles.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files(template_id, file_type="pdf") - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFiles.rb b/examples/TemplateFiles.rb deleted file mode 100644 index 0ad5d6070..000000000 --- a/examples/TemplateFiles.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - file_bin = template_api.template_files(template_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateFiles.ts b/examples/TemplateFiles.ts deleted file mode 100644 index 00217b49b..000000000 --- a/examples/TemplateFiles.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; -const fileType = "pdf"; - -const result = templateApi.templateFiles(templateId, fileType); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsDataUri.cs b/examples/TemplateFilesAsDataUri.cs deleted file mode 100644 index 0d999f5ac..000000000 --- a/examples/TemplateFilesAsDataUri.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateFilesAsDataUri(templateId, "pdf", false, false); - 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/TemplateFilesAsDataUri.java b/examples/TemplateFilesAsDataUri.java deleted file mode 100644 index 868f2803a..000000000 --- a/examples/TemplateFilesAsDataUri.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponseDataUri result = templateApi.templateFilesAsDataUri(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateFilesAsDataUri.js b/examples/TemplateFilesAsDataUri.js deleted file mode 100644 index 8e0f53654..000000000 --- a/examples/TemplateFilesAsDataUri.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsDataUri(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsDataUri.php b/examples/TemplateFilesAsDataUri.php deleted file mode 100644 index f52cc28ea..000000000 --- a/examples/TemplateFilesAsDataUri.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateFilesAsDataUri($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateFilesAsDataUri.py b/examples/TemplateFilesAsDataUri.py deleted file mode 100644 index 9dbc44e4a..000000000 --- a/examples/TemplateFilesAsDataUri.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files_as_data_uri(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsDataUri.rb b/examples/TemplateFilesAsDataUri.rb deleted file mode 100644 index a6689553b..000000000 --- a/examples/TemplateFilesAsDataUri.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_files_as_data_uri(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateFilesAsDataUri.ts b/examples/TemplateFilesAsDataUri.ts deleted file mode 100644 index 8e0f53654..000000000 --- a/examples/TemplateFilesAsDataUri.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsDataUri(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsDataUriExample.cs b/examples/TemplateFilesAsDataUriExample.cs new file mode 100644 index 000000000..5c946b84a --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsDataUri( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateFilesAsDataUriExample.java b/examples/TemplateFilesAsDataUriExample.java new file mode 100644 index 000000000..6ef950fe3 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateFilesAsDataUriExample.php b/examples/TemplateFilesAsDataUriExample.php new file mode 100644 index 000000000..df19ef818 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsDataUri( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/examples/TemplateFilesAsDataUriExample.py b/examples/TemplateFilesAsDataUriExample.py new file mode 100644 index 000000000..ce91dc6ec --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_data_uri( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_data_uri: %s\n" % e) diff --git a/examples/TemplateFilesAsDataUriExample.rb b/examples/TemplateFilesAsDataUriExample.rb new file mode 100644 index 000000000..c51e03680 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files_as_data_uri( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_data_uri: #{e}" +end diff --git a/examples/TemplateFilesAsDataUri.sh b/examples/TemplateFilesAsDataUriExample.sh similarity index 100% rename from examples/TemplateFilesAsDataUri.sh rename to examples/TemplateFilesAsDataUriExample.sh diff --git a/examples/TemplateFilesAsDataUriExample.ts b/examples/TemplateFilesAsDataUriExample.ts new file mode 100644 index 000000000..40a8e2ac0 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/examples/TemplateFilesAsFileUrl.cs b/examples/TemplateFilesAsFileUrl.cs deleted file mode 100644 index 4bdc39d81..000000000 --- a/examples/TemplateFilesAsFileUrl.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateFilesAsFileUrl(templateId, "pdf", false, false); - 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/TemplateFilesAsFileUrl.java b/examples/TemplateFilesAsFileUrl.java deleted file mode 100644 index a3989a61f..000000000 --- a/examples/TemplateFilesAsFileUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponse result = templateApi.templateFilesAsFileUrl(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateFilesAsFileUrl.js b/examples/TemplateFilesAsFileUrl.js deleted file mode 100644 index 305392726..000000000 --- a/examples/TemplateFilesAsFileUrl.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsFileUrl(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsFileUrl.php b/examples/TemplateFilesAsFileUrl.php deleted file mode 100644 index 36a061b98..000000000 --- a/examples/TemplateFilesAsFileUrl.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateFilesAsFileUrl($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateFilesAsFileUrl.py b/examples/TemplateFilesAsFileUrl.py deleted file mode 100644 index c1a8da3a7..000000000 --- a/examples/TemplateFilesAsFileUrl.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files_as_file_url(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsFileUrl.rb b/examples/TemplateFilesAsFileUrl.rb deleted file mode 100644 index b5502db1c..000000000 --- a/examples/TemplateFilesAsFileUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_files_as_file_url(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateFilesAsFileUrl.ts b/examples/TemplateFilesAsFileUrl.ts deleted file mode 100644 index 305392726..000000000 --- a/examples/TemplateFilesAsFileUrl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsFileUrl(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsFileUrlExample.cs b/examples/TemplateFilesAsFileUrlExample.cs new file mode 100644 index 000000000..3b5bc98f1 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsFileUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateFilesAsFileUrlExample.java b/examples/TemplateFilesAsFileUrlExample.java new file mode 100644 index 000000000..3ac688da1 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateFilesAsFileUrlExample.php b/examples/TemplateFilesAsFileUrlExample.php new file mode 100644 index 000000000..d4fb8f53c --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsFileUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/examples/TemplateFilesAsFileUrlExample.py b/examples/TemplateFilesAsFileUrlExample.py new file mode 100644 index 000000000..052891df2 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_file_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_file_url: %s\n" % e) diff --git a/examples/TemplateFilesAsFileUrlExample.rb b/examples/TemplateFilesAsFileUrlExample.rb new file mode 100644 index 000000000..055fd32f6 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files_as_file_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_file_url: #{e}" +end diff --git a/examples/TemplateFilesAsFileUrl.sh b/examples/TemplateFilesAsFileUrlExample.sh similarity index 100% rename from examples/TemplateFilesAsFileUrl.sh rename to examples/TemplateFilesAsFileUrlExample.sh diff --git a/examples/TemplateFilesAsFileUrlExample.ts b/examples/TemplateFilesAsFileUrlExample.ts new file mode 100644 index 000000000..e80f1ad91 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/examples/TemplateFilesExample.cs b/examples/TemplateFilesExample.cs new file mode 100644 index 000000000..96e9237ee --- /dev/null +++ b/examples/TemplateFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + fileType: null + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateFilesExample.java b/examples/TemplateFilesExample.java new file mode 100644 index 000000000..90c2975b2 --- /dev/null +++ b/examples/TemplateFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateFilesExample.php b/examples/TemplateFilesExample.php new file mode 100644 index 000000000..c9d7d5307 --- /dev/null +++ b/examples/TemplateFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + file_type: null, + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}"; +} diff --git a/examples/TemplateFilesExample.py b/examples/TemplateFilesExample.py new file mode 100644 index 000000000..712642766 --- /dev/null +++ b/examples/TemplateFilesExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + file_type=None, + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling TemplateApi#template_files: %s\n" % e) diff --git a/examples/TemplateFilesExample.rb b/examples/TemplateFilesExample.rb new file mode 100644 index 000000000..6aef00074 --- /dev/null +++ b/examples/TemplateFilesExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files: #{e}" +end diff --git a/examples/TemplateFiles.sh b/examples/TemplateFilesExample.sh similarity index 100% rename from examples/TemplateFiles.sh rename to examples/TemplateFilesExample.sh diff --git a/examples/TemplateFilesExample.ts b/examples/TemplateFilesExample.ts new file mode 100644 index 000000000..923f16d56 --- /dev/null +++ b/examples/TemplateFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + undefined, // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFiles:"); + console.log(error.body); +}); diff --git a/examples/TemplateGet.cs b/examples/TemplateGet.cs deleted file mode 100644 index 8354820fd..000000000 --- a/examples/TemplateGet.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateGet(templateId); - 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/TemplateGet.java b/examples/TemplateGet.java deleted file mode 100644 index 5c4721fd7..000000000 --- a/examples/TemplateGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateGet(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateGet.js b/examples/TemplateGet.js deleted file mode 100644 index 365fe69b9..000000000 --- a/examples/TemplateGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateGet(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateGet.php b/examples/TemplateGet.php deleted file mode 100644 index b6e469748..000000000 --- a/examples/TemplateGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateGet($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateGet.py b/examples/TemplateGet.py deleted file mode 100644 index 1c41b3649..000000000 --- a/examples/TemplateGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_get(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateGet.rb b/examples/TemplateGet.rb deleted file mode 100644 index f308d2b7b..000000000 --- a/examples/TemplateGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "f57db65d3f933b5316d398057a36176831451a35" - -begin - result = template_api.template_get(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateGet.ts b/examples/TemplateGet.ts deleted file mode 100644 index 365fe69b9..000000000 --- a/examples/TemplateGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateGet(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateGetExample.cs b/examples/TemplateGetExample.cs new file mode 100644 index 000000000..067300032 --- /dev/null +++ b/examples/TemplateGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateGet( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateGetExample.java b/examples/TemplateGetExample.java new file mode 100644 index 000000000..affbf4d04 --- /dev/null +++ b/examples/TemplateGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateGetExample.php b/examples/TemplateGetExample.php new file mode 100644 index 000000000..3625ff5a4 --- /dev/null +++ b/examples/TemplateGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateGet( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateGet: {$e->getMessage()}"; +} diff --git a/examples/TemplateGetExample.py b/examples/TemplateGetExample.py new file mode 100644 index 000000000..2226f74d0 --- /dev/null +++ b/examples/TemplateGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_get( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_get: %s\n" % e) diff --git a/examples/TemplateGetExample.rb b/examples/TemplateGetExample.rb new file mode 100644 index 000000000..aacf15e90 --- /dev/null +++ b/examples/TemplateGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_get( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_get: #{e}" +end diff --git a/examples/TemplateGet.sh b/examples/TemplateGetExample.sh similarity index 100% rename from examples/TemplateGet.sh rename to examples/TemplateGetExample.sh diff --git a/examples/TemplateGetExample.ts b/examples/TemplateGetExample.ts new file mode 100644 index 000000000..b4fcdda6c --- /dev/null +++ b/examples/TemplateGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateGet( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateGet:"); + console.log(error.body); +}); diff --git a/examples/TemplateList.cs b/examples/TemplateList.cs deleted file mode 100644 index b6cb40dc2..000000000 --- a/examples/TemplateList.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateList(accountId, 1, 20, null); - 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/TemplateList.java b/examples/TemplateList.java deleted file mode 100644 index 136dcf3be..000000000 --- a/examples/TemplateList.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - TemplateListResponse result = templateApi.templateList(accountId, page, pageSize, query); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateList.js b/examples/TemplateList.js deleted file mode 100644 index be9197a82..000000000 --- a/examples/TemplateList.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateList(accountId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateList.php b/examples/TemplateList.php deleted file mode 100644 index 1a2ea5b13..000000000 --- a/examples/TemplateList.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateList($accountId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateList.py b/examples/TemplateList.py deleted file mode 100644 index 4ce779ffe..000000000 --- a/examples/TemplateList.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - account_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_list( - account_id=account_id, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateList.rb b/examples/TemplateList.rb deleted file mode 100644 index e0006c738..000000000 --- a/examples/TemplateList.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -account_id = "f57db65d3f933b5316d398057a36176831451a35" - -begin - result = template_api.template_list({ account_id: account_id }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateList.ts b/examples/TemplateList.ts deleted file mode 100644 index be9197a82..000000000 --- a/examples/TemplateList.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateList(accountId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateListExample.cs b/examples/TemplateListExample.cs new file mode 100644 index 000000000..b41f357ce --- /dev/null +++ b/examples/TemplateListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateListExample.java b/examples/TemplateListExample.java new file mode 100644 index 000000000..45250a456 --- /dev/null +++ b/examples/TemplateListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateListExample.php b/examples/TemplateListExample.php new file mode 100644 index 000000000..536c2a630 --- /dev/null +++ b/examples/TemplateListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}"; +} diff --git a/examples/TemplateListExample.py b/examples/TemplateListExample.py new file mode 100644 index 000000000..6b96ea19c --- /dev/null +++ b/examples/TemplateListExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_list( + account_id=None, + page=1, + page_size=20, + query=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_list: %s\n" % e) diff --git a/examples/TemplateListExample.rb b/examples/TemplateListExample.rb new file mode 100644 index 000000000..a69c46f66 --- /dev/null +++ b/examples/TemplateListExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_list: #{e}" +end diff --git a/examples/TemplateList.sh b/examples/TemplateListExample.sh similarity index 100% rename from examples/TemplateList.sh rename to examples/TemplateListExample.sh diff --git a/examples/TemplateListExample.ts b/examples/TemplateListExample.ts new file mode 100644 index 000000000..e678a6c26 --- /dev/null +++ b/examples/TemplateListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateList:"); + console.log(error.body); +}); diff --git a/examples/TemplateRemoveUser.cs b/examples/TemplateRemoveUser.cs deleted file mode 100644 index da93c4c7d..000000000 --- a/examples/TemplateRemoveUser.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var data = new TemplateRemoveUserRequest( - emailAddress: "george@dropboxsign.com" - ); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try - { - var result = templateApi.TemplateRemoveUser(templateId, 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/examples/TemplateRemoveUser.java b/examples/TemplateRemoveUser.java deleted file mode 100644 index 9dd210c08..000000000 --- a/examples/TemplateRemoveUser.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateRemoveUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateGetResponse result = templateApi.templateRemoveUser(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateRemoveUser.js b/examples/TemplateRemoveUser.js deleted file mode 100644 index 9683986c1..000000000 --- a/examples/TemplateRemoveUser.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -const result = templateApi.templateRemoveUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateRemoveUser.php b/examples/TemplateRemoveUser.php deleted file mode 100644 index 8e7aa9a97..000000000 --- a/examples/TemplateRemoveUser.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateRemoveUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -try { - $result = $templateApi->templateRemoveUser($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateRemoveUser.py b/examples/TemplateRemoveUser.py deleted file mode 100644 index c16c4b001..000000000 --- a/examples/TemplateRemoveUser.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateRemoveUserRequest( - email_address="george@dropboxsign.com", - ) - - template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - - try: - response = template_api.template_remove_user(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateRemoveUser.rb b/examples/TemplateRemoveUser.rb deleted file mode 100644 index b9035297a..000000000 --- a/examples/TemplateRemoveUser.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateRemoveUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - -begin - result = template_api.template_remove_user(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateRemoveUser.ts b/examples/TemplateRemoveUser.ts deleted file mode 100644 index 7bd823902..000000000 --- a/examples/TemplateRemoveUser.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateRemoveUserRequest = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -const result = templateApi.templateRemoveUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateRemoveUserExample.cs b/examples/TemplateRemoveUserExample.cs new file mode 100644 index 000000000..66bcbfe53 --- /dev/null +++ b/examples/TemplateRemoveUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateRemoveUserRequest = new TemplateRemoveUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateRemoveUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateRemoveUserRequest: templateRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateRemoveUserExample.java b/examples/TemplateRemoveUserExample.java new file mode 100644 index 000000000..d3d157b24 --- /dev/null +++ b/examples/TemplateRemoveUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateRemoveUserExample.php b/examples/TemplateRemoveUserExample.php new file mode 100644 index 000000000..ecd5770f4 --- /dev/null +++ b/examples/TemplateRemoveUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_remove_user_request = (new Dropbox\Sign\Model\TemplateRemoveUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateRemoveUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request: $template_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateRemoveUser: {$e->getMessage()}"; +} diff --git a/examples/TemplateRemoveUserExample.py b/examples/TemplateRemoveUserExample.py new file mode 100644 index 000000000..c44814c40 --- /dev/null +++ b/examples/TemplateRemoveUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_remove_user_request = models.TemplateRemoveUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_remove_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request=template_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_remove_user: %s\n" % e) diff --git a/examples/TemplateRemoveUserExample.rb b/examples/TemplateRemoveUserExample.rb new file mode 100644 index 000000000..00687e102 --- /dev/null +++ b/examples/TemplateRemoveUserExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_remove_user_request = Dropbox::Sign::TemplateRemoveUserRequest.new +template_remove_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_remove_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_remove_user: #{e}" +end diff --git a/examples/TemplateRemoveUser.sh b/examples/TemplateRemoveUserExample.sh similarity index 100% rename from examples/TemplateRemoveUser.sh rename to examples/TemplateRemoveUserExample.sh diff --git a/examples/TemplateRemoveUserExample.ts b/examples/TemplateRemoveUserExample.ts new file mode 100644 index 000000000..f896f81e1 --- /dev/null +++ b/examples/TemplateRemoveUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateRemoveUserRequest = new models.TemplateRemoveUserRequest(); +templateRemoveUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateRemoveUser:"); + console.log(error.body); +}); diff --git a/examples/TemplateUpdateFiles.cs b/examples/TemplateUpdateFiles.cs deleted file mode 100644 index 1ac81efd8..000000000 --- a/examples/TemplateUpdateFiles.cs +++ /dev/null @@ -1,48 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateUpdateFilesRequest( - files: files - ); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try - { - var result = templateApi.TemplateUpdateFiles(templateId, 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/examples/TemplateUpdateFiles.java b/examples/TemplateUpdateFiles.java deleted file mode 100644 index 873544c84..000000000 --- a/examples/TemplateUpdateFiles.java +++ /dev/null @@ -1,38 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateUpdateFilesRequest() - .addFilesItem(new File("example_signature_request.pdf")); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateUpdateFilesResponse result = templateApi.templateUpdateFiles(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateUpdateFiles.js b/examples/TemplateUpdateFiles.js deleted file mode 100644 index 81eb26ecc..000000000 --- a/examples/TemplateUpdateFiles.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - files: [fs.createReadStream("example_signature_request.pdf")], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateUpdateFiles(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateUpdateFiles.php b/examples/TemplateUpdateFiles.php deleted file mode 100644 index c9e3fbe62..000000000 --- a/examples/TemplateUpdateFiles.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateUpdateFilesRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateUpdateFiles($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateUpdateFiles.py b/examples/TemplateUpdateFiles.py deleted file mode 100644 index 341af5020..000000000 --- a/examples/TemplateUpdateFiles.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateUpdateFilesRequest( - files=[open("example_signature_request.pdf", "rb")], - ) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_update_files(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateUpdateFiles.rb b/examples/TemplateUpdateFiles.rb deleted file mode 100644 index f4c31e0c7..000000000 --- a/examples/TemplateUpdateFiles.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateUpdateFilesRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_update_files(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateUpdateFiles.ts b/examples/TemplateUpdateFiles.ts deleted file mode 100644 index ce6bee73e..000000000 --- a/examples/TemplateUpdateFiles.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import fs from "fs"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateUpdateFilesRequest = { - files: [fs.createReadStream("example_signature_request.pdf")], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateUpdateFiles(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateUpdateFilesExample.cs b/examples/TemplateUpdateFilesExample.cs new file mode 100644 index 000000000..1fe2ccf5e --- /dev/null +++ b/examples/TemplateUpdateFilesExample.cs @@ -0,0 +1,46 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateUpdateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest( + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new TemplateApi(config).TemplateUpdateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateUpdateFilesRequest: templateUpdateFilesRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateUpdateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateUpdateFilesExample.java b/examples/TemplateUpdateFilesExample.java new file mode 100644 index 000000000..865668461 --- /dev/null +++ b/examples/TemplateUpdateFilesExample.java @@ -0,0 +1,46 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateUpdateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateUpdateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateUpdateFilesExample.php b/examples/TemplateUpdateFilesExample.php new file mode 100644 index 000000000..26470da0f --- /dev/null +++ b/examples/TemplateUpdateFilesExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_update_files_request = (new Dropbox\Sign\Model\TemplateUpdateFilesRequest()) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request: $template_update_files_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateUpdateFiles: {$e->getMessage()}"; +} diff --git a/examples/TemplateUpdateFilesExample.py b/examples/TemplateUpdateFilesExample.py new file mode 100644 index 000000000..71ab006be --- /dev/null +++ b/examples/TemplateUpdateFilesExample.py @@ -0,0 +1,27 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_update_files_request = models.TemplateUpdateFilesRequest( + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.TemplateApi(api_client).template_update_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request=template_update_files_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_update_files: %s\n" % e) diff --git a/examples/TemplateUpdateFilesExample.rb b/examples/TemplateUpdateFilesExample.rb new file mode 100644 index 000000000..d5088f2a7 --- /dev/null +++ b/examples/TemplateUpdateFilesExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_update_files_request = Dropbox::Sign::TemplateUpdateFilesRequest.new +template_update_files_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::TemplateApi.new.template_update_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_update_files_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_update_files: #{e}" +end diff --git a/examples/TemplateUpdateFiles.sh b/examples/TemplateUpdateFilesExample.sh similarity index 100% rename from examples/TemplateUpdateFiles.sh rename to examples/TemplateUpdateFilesExample.sh diff --git a/examples/TemplateUpdateFilesExample.ts b/examples/TemplateUpdateFilesExample.ts new file mode 100644 index 000000000..139a53fff --- /dev/null +++ b/examples/TemplateUpdateFilesExample.ts @@ -0,0 +1,22 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateUpdateFilesRequest = new models.TemplateUpdateFilesRequest(); +templateUpdateFilesRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateUpdateFiles:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreate.cs b/examples/UnclaimedDraftCreate.cs deleted file mode 100644 index b645322e5..000000000 --- a/examples/UnclaimedDraftCreate.cs +++ /dev/null @@ -1,85 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var signer1 = new SubUnclaimedDraftSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubUnclaimedDraftSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY - ); - - var metadata = new Dictionary() - { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new UnclaimedDraftCreateRequest( - subject: "The NDA we talked about", - type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: subSigningOptions, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = unclaimedDraftApi.UnclaimedDraftCreate(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/examples/UnclaimedDraftCreate.java b/examples/UnclaimedDraftCreate.java deleted file mode 100644 index 5ba805715..000000000 --- a/examples/UnclaimedDraftCreate.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer1 = new SubUnclaimedDraftSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubUnclaimedDraftSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); - - var data = new UnclaimedDraftCreateRequest() - .subject("The NDA we talked about") - .type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE) - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(subSigningOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftCreate.js b/examples/UnclaimedDraftCreate.js deleted file mode 100644 index 70d1c2a05..000000000 --- a/examples/UnclaimedDraftCreate.js +++ /dev/null @@ -1,64 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - subject: "The NDA we talked about", - type: "request_signature", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ - signer1, - signer2, - ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreate.php b/examples/UnclaimedDraftCreate.php deleted file mode 100644 index e9d7bee89..000000000 --- a/examples/UnclaimedDraftCreate.php +++ /dev/null @@ -1,60 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateRequest(); -$data->setSubject("The NDA we talked about") - ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftCreate.rb b/examples/UnclaimedDraftCreate.rb deleted file mode 100644 index 36d7ff747..000000000 --- a/examples/UnclaimedDraftCreate.rb +++ /dev/null @@ -1,56 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -signer_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubUnclaimedDraftSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::UnclaimedDraftCreateRequest.new -data.subject = "The NDA we talked about" -data.type = "request_signature" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", -] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true - -begin - result = unclaimed_draft_api.unclaimed_draft_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreate.ts b/examples/UnclaimedDraftCreate.ts deleted file mode 100644 index 137fc64e2..000000000 --- a/examples/UnclaimedDraftCreate.ts +++ /dev/null @@ -1,64 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubUnclaimedDraftSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubUnclaimedDraftSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.UnclaimedDraftCreateRequest = { - subject: "The NDA we talked about", - type: DropboxSign.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ - signer1, - signer2, - ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbedded.cs b/examples/UnclaimedDraftCreateEmbedded.cs deleted file mode 100644 index 294663094..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.cs +++ /dev/null @@ -1,49 +0,0 @@ -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(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new UnclaimedDraftCreateEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: files, - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true - ); - - try - { - var result = unclaimedDraftApi.UnclaimedDraftCreateEmbedded(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/examples/UnclaimedDraftCreateEmbedded.java b/examples/UnclaimedDraftCreateEmbedded.java deleted file mode 100644 index 56ad9a5ae..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .addFilesItem(new File("example_signature_request.pdf")) - .requesterEmailAddress("jack@dropboxsign.com") - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftCreateEmbedded.js b/examples/UnclaimedDraftCreateEmbedded.js deleted file mode 100644 index 6f0865c8e..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.js +++ /dev/null @@ -1,25 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: [fs.createReadStream("example_signature_request.pdf")], - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbedded.php b/examples/UnclaimedDraftCreateEmbedded.php deleted file mode 100644 index b163ca833..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbedded($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftCreateEmbedded.py b/examples/UnclaimedDraftCreateEmbedded.py deleted file mode 100644 index a5f260c23..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.py +++ /dev/null @@ -1,26 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - files=[open("example_signature_request.pdf", "rb")], - requester_email_address="jack@dropboxsign.com", - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbedded.rb b/examples/UnclaimedDraftCreateEmbedded.rb deleted file mode 100644 index ab80ad56c..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.files = [File.new("example_signature_request.pdf", "r")] -data.requester_email_address = "jack@dropboxsign.com" -data.test_mode = true - -begin - result = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbedded.ts b/examples/UnclaimedDraftCreateEmbedded.ts deleted file mode 100644 index 5dbdaab51..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.ts +++ /dev/null @@ -1,25 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.UnclaimedDraftCreateEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: [fs.createReadStream("example_signature_request.pdf")], - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.cs b/examples/UnclaimedDraftCreateEmbeddedExample.cs new file mode 100644 index 000000000..4637922b5 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.cs @@ -0,0 +1,48 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.java b/examples/UnclaimedDraftCreateEmbeddedExample.java new file mode 100644 index 000000000..0dfd50d88 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.java @@ -0,0 +1,48 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.php b/examples/UnclaimedDraftCreateEmbeddedExample.php new file mode 100644 index 000000000..4ad74cf2c --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(true) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.py b/examples/UnclaimedDraftCreateEmbeddedExample.py new file mode 100644 index 000000000..dade05ec4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.py @@ -0,0 +1,29 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.rb b/examples/UnclaimedDraftCreateEmbeddedExample.rb new file mode 100644 index 000000000..a22330de8 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.rb @@ -0,0 +1,25 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = true +unclaimed_draft_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbedded.sh b/examples/UnclaimedDraftCreateEmbeddedExample.sh similarity index 100% rename from examples/UnclaimedDraftCreateEmbedded.sh rename to examples/UnclaimedDraftCreateEmbeddedExample.sh diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.ts b/examples/UnclaimedDraftCreateEmbeddedExample.ts new file mode 100644 index 000000000..d17be1564 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.ts @@ -0,0 +1,24 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = true; +unclaimedDraftCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs new file mode 100644 index 000000000..58e77d162 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs @@ -0,0 +1,95 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java new file mode 100644 index 000000000..f597e3e18 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java @@ -0,0 +1,94 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php new file mode 100644 index 000000000..c56719913 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php @@ -0,0 +1,76 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py new file mode 100644 index 000000000..b825eeac8 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py @@ -0,0 +1,78 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb new file mode 100644 index 000000000..46129e4d7 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb @@ -0,0 +1,71 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_groups = form_field_groups +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts new file mode 100644 index 000000000..bb10352f4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts @@ -0,0 +1,70 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs new file mode 100644 index 000000000..367136511 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs @@ -0,0 +1,115 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java new file mode 100644 index 000000000..d2483f32f --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java @@ -0,0 +1,110 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php new file mode 100644 index 000000000..2280c7252 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php @@ -0,0 +1,92 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py new file mode 100644 index 000000000..931cc0bdd --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py @@ -0,0 +1,96 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb new file mode 100644 index 000000000..a6b174891 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb @@ -0,0 +1,87 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_rules = form_field_rules +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts new file mode 100644 index 000000000..8223f693e --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts @@ -0,0 +1,86 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..f9b29f003 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs @@ -0,0 +1,81 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..f425a3d36 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java @@ -0,0 +1,82 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..249c7eacb --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php @@ -0,0 +1,64 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..6828613cd --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py @@ -0,0 +1,65 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..774085a28 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb @@ -0,0 +1,59 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..66efc0596 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts @@ -0,0 +1,58 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs deleted file mode 100644 index 775c42111..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs +++ /dev/null @@ -1,52 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var signer = new SubUnclaimedDraftTemplateSigner( - role: "Client", - name: "George", - emailAddress: "george@example.com" - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - requesterEmailAddress: "jack@dropboxsign.com", - signers: new List(){signer}, - ccs: new List(){cc1}, - testMode: true - ); - - try - { - var result = unclaimedDraftApi.UnclaimedDraftCreateEmbeddedWithTemplate(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/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java deleted file mode 100644 index 7a5983a75..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,50 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer = new SubUnclaimedDraftTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .requesterEmailAddress("jack@dropboxsign.com") - .signers(List.of(signer)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js deleted file mode 100644 index 097712e7f..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js +++ /dev/null @@ -1,37 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - name: "George", - emailAddress: "george@example.com", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@dropboxsign.com", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requesterEmailAddress: "jack@dropboxsign.com", - signers: [ signer1 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php deleted file mode 100644 index 7d870ac3c..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php +++ /dev/null @@ -1,39 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner(); -$signer1->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@dropboxsign.com"); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["61a832ff0d8423f91d503e76bfbcc750f7417c78"]) - ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py deleted file mode 100644 index c4122b185..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,41 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requester_email_address="jack@dropboxsign.com", - signers=[signer_1], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template( - data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb deleted file mode 100644 index abe1f5ca6..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,35 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -signer_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new -signer_1.role = "Client" -signer_1.name = "George" -signer_1.email_address = "george@example.com" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["61a832ff0d8423f91d503e76bfbcc750f7417c78"] -data.requester_email_address = "jack@dropboxsign.com" -data.signers = [signer_1] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts deleted file mode 100644 index cc23f74af..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts +++ /dev/null @@ -1,37 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubUnclaimedDraftTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@dropboxsign.com", -}; - -const data: DropboxSign.UnclaimedDraftCreateEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requesterEmailAddress: "jack@dropboxsign.com", - signers: [ signer1 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..2fea6ff83 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@dropboxsign.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signers1 = new SubUnclaimedDraftTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + testMode: false, + ccs: ccs, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest: unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..174c678a4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..d51e60ee7 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@dropboxsign.com"); + +$ccs = [ + $ccs_1, +]; + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_embedded_with_template_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setTestMode(false) + ->setCcs($ccs) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbeddedWithTemplate( + unclaimed_draft_create_embedded_with_template_request: $unclaimed_draft_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..fbb76e6bf --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,50 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@dropboxsign.com", + ) + + ccs = [ + ccs_1, + ] + + signers_1 = models.SubUnclaimedDraftTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_embedded_with_template_request = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + test_mode=False, + ccs=ccs, + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request=unclaimed_draft_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..c6e799cae --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@dropboxsign.com" + +ccs = [ + ccs_1, +] + +signers_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +unclaimed_draft_create_embedded_with_template_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new +unclaimed_draft_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_with_template_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +unclaimed_draft_create_embedded_with_template_request.test_mode = false +unclaimed_draft_create_embedded_with_template_request.ccs = ccs +unclaimed_draft_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh rename to examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..8e78741d8 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@dropboxsign.com"; + +const ccs = [ + ccs1, +]; + +const signers1 = new models.SubUnclaimedDraftTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateEmbeddedWithTemplateRequest = new models.UnclaimedDraftCreateEmbeddedWithTemplateRequest(); +unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode = false; +unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs = ccs; +unclaimedDraftCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateExample.cs b/examples/UnclaimedDraftCreateExample.cs new file mode 100644 index 000000000..e5080a671 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.cs @@ -0,0 +1,59 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signers1 = new SubUnclaimedDraftSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateExample.java b/examples/UnclaimedDraftCreateExample.java new file mode 100644 index 000000000..219de1f5a --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.java @@ -0,0 +1,57 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateExample.php b/examples/UnclaimedDraftCreateExample.php new file mode 100644 index 000000000..8aa132af0 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.php @@ -0,0 +1,38 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(true) + ->setFiles([ + ]) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateExample.py b/examples/UnclaimedDraftCreateExample.py new file mode 100644 index 000000000..f7715b7ea --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.py @@ -0,0 +1,39 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signers_1 = models.SubUnclaimedDraftSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateExample.rb b/examples/UnclaimedDraftCreateExample.rb new file mode 100644 index 000000000..12f94dfd2 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.rb @@ -0,0 +1,34 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signers_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers = [ + signers_1, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = true +unclaimed_draft_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +unclaimed_draft_create_request.signers = signers + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreate.sh b/examples/UnclaimedDraftCreateExample.sh similarity index 100% rename from examples/UnclaimedDraftCreate.sh rename to examples/UnclaimedDraftCreateExample.sh diff --git a/examples/UnclaimedDraftCreateExample.ts b/examples/UnclaimedDraftCreateExample.ts new file mode 100644 index 000000000..dc23f50d2 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.ts @@ -0,0 +1,33 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signers1 = new models.SubUnclaimedDraftSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = true; +unclaimedDraftCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +unclaimedDraftCreateRequest.signers = signers; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.cs b/examples/UnclaimedDraftCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b5ae35929 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.cs @@ -0,0 +1,94 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.java b/examples/UnclaimedDraftCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..e30a749bb --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.java @@ -0,0 +1,93 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.php b/examples/UnclaimedDraftCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..92ec35b20 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.php @@ -0,0 +1,75 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.py b/examples/UnclaimedDraftCreateFormFieldGroupsExample.py new file mode 100644 index 000000000..4af69152a --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.py @@ -0,0 +1,77 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb b/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb new file mode 100644 index 000000000..881fde8ab --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb @@ -0,0 +1,70 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_groups = form_field_groups +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.ts b/examples/UnclaimedDraftCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..f3e47da2c --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.ts @@ -0,0 +1,69 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.cs b/examples/UnclaimedDraftCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..dabc20ce6 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.cs @@ -0,0 +1,114 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.java b/examples/UnclaimedDraftCreateFormFieldRulesExample.java new file mode 100644 index 000000000..49de71fbe --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.java @@ -0,0 +1,109 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.php b/examples/UnclaimedDraftCreateFormFieldRulesExample.php new file mode 100644 index 000000000..a58ad4d10 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.php @@ -0,0 +1,91 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.py b/examples/UnclaimedDraftCreateFormFieldRulesExample.py new file mode 100644 index 000000000..a0bba3023 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.rb b/examples/UnclaimedDraftCreateFormFieldRulesExample.rb new file mode 100644 index 000000000..54822f3a7 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.rb @@ -0,0 +1,86 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_rules = form_field_rules +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.ts b/examples/UnclaimedDraftCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..c4abba3b1 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.ts @@ -0,0 +1,85 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..86eae8aea --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,80 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..b048a8ba9 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,81 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..93e3b015a --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,63 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..d15b6c577 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,64 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..e4bc66ec0 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,58 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..b5e61ab5a --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,57 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftEditAndResend.cs b/examples/UnclaimedDraftEditAndResend.cs deleted file mode 100644 index cfbb3709a..000000000 --- a/examples/UnclaimedDraftEditAndResend.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System; -using System.Collections.Generic; -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"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var data = new UnclaimedDraftEditAndResendRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - testMode: true - ); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - - try - { - var result = unclaimedDraftApi.UnclaimedDraftEditAndResend(signatureRequestId, 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/examples/UnclaimedDraftEditAndResend.java b/examples/UnclaimedDraftEditAndResend.java deleted file mode 100644 index bf33d8f69..000000000 --- a/examples/UnclaimedDraftEditAndResend.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftEditAndResendRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .testMode(true); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftEditAndResend.js b/examples/UnclaimedDraftEditAndResend.js deleted file mode 100644 index 0ff7c3683..000000000 --- a/examples/UnclaimedDraftEditAndResend.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - testMode: true, -}; - -const signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -const result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftEditAndResend.php b/examples/UnclaimedDraftEditAndResend.php deleted file mode 100644 index 5f985d8c6..000000000 --- a/examples/UnclaimedDraftEditAndResend.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -try { - $result = $unclaimedDraftApi->unclaimedDraftEditAndResend($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftEditAndResend.py b/examples/UnclaimedDraftEditAndResend.py deleted file mode 100644 index bbcad88ff..000000000 --- a/examples/UnclaimedDraftEditAndResend.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftEditAndResendRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - test_mode=True, - ) - - signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - - try: - response = unclaimed_draft_api.unclaimed_draft_edit_and_resend( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftEditAndResend.rb b/examples/UnclaimedDraftEditAndResend.rb deleted file mode 100644 index 9b4b1c7b6..000000000 --- a/examples/UnclaimedDraftEditAndResend.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -data = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.test_mode = true - -signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - -begin - result = unclaimed_draft_api.unclaimed_draft_edit_and_resend(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftEditAndResend.ts b/examples/UnclaimedDraftEditAndResend.ts deleted file mode 100644 index 320b0b750..000000000 --- a/examples/UnclaimedDraftEditAndResend.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.UnclaimedDraftEditAndResendRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - testMode: true, -}; - -const signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -const result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftEditAndResendExample.cs b/examples/UnclaimedDraftEditAndResendExample.cs new file mode 100644 index 000000000..459364b01 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftEditAndResendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + testMode: false + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftEditAndResend( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimedDraftEditAndResendRequest: unclaimedDraftEditAndResendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftEditAndResend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftEditAndResendExample.java b/examples/UnclaimedDraftEditAndResendExample.java new file mode 100644 index 000000000..4866e6524 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftEditAndResendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftEditAndResendExample.php b/examples/UnclaimedDraftEditAndResendExample.php new file mode 100644 index 000000000..f82ea4946 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_edit_and_resend_request = (new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTestMode(false); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftEditAndResend( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request: $unclaimed_draft_edit_and_resend_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftEditAndResendExample.py b/examples/UnclaimedDraftEditAndResendExample.py new file mode 100644 index 000000000..440aaaa9e --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_edit_and_resend_request = models.UnclaimedDraftEditAndResendRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + test_mode=False, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_edit_and_resend( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request=unclaimed_draft_edit_and_resend_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: %s\n" % e) diff --git a/examples/UnclaimedDraftEditAndResendExample.rb b/examples/UnclaimedDraftEditAndResendExample.rb new file mode 100644 index 000000000..dccc4d027 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +unclaimed_draft_edit_and_resend_request = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new +unclaimed_draft_edit_and_resend_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_edit_and_resend_request.test_mode = false + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_edit_and_resend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + unclaimed_draft_edit_and_resend_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: #{e}" +end diff --git a/examples/UnclaimedDraftEditAndResend.sh b/examples/UnclaimedDraftEditAndResendExample.sh similarity index 100% rename from examples/UnclaimedDraftEditAndResend.sh rename to examples/UnclaimedDraftEditAndResendExample.sh diff --git a/examples/UnclaimedDraftEditAndResendExample.ts b/examples/UnclaimedDraftEditAndResendExample.ts new file mode 100644 index 000000000..16a998390 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftEditAndResendRequest = new models.UnclaimedDraftEditAndResendRequest(); +unclaimedDraftEditAndResendRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftEditAndResendRequest.testMode = false; + +apiCaller.unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend:"); + console.log(error.body); +}); diff --git a/examples/json/AccountCreateOAuthResponseExample.json b/examples/json/AccountCreateOAuthResponse.json similarity index 100% rename from examples/json/AccountCreateOAuthResponseExample.json rename to examples/json/AccountCreateOAuthResponse.json diff --git a/examples/json/AccountCreateRequestDefaultExample.json b/examples/json/AccountCreateRequest.json similarity index 100% rename from examples/json/AccountCreateRequestDefaultExample.json rename to examples/json/AccountCreateRequest.json diff --git a/examples/json/AccountCreateRequestOAuthExample.json b/examples/json/AccountCreateRequestOAuth.json similarity index 100% rename from examples/json/AccountCreateRequestOAuthExample.json rename to examples/json/AccountCreateRequestOAuth.json diff --git a/examples/json/AccountCreateResponseExample.json b/examples/json/AccountCreateResponse.json similarity index 100% rename from examples/json/AccountCreateResponseExample.json rename to examples/json/AccountCreateResponse.json diff --git a/examples/json/AccountGetResponseExample.json b/examples/json/AccountGetResponse.json similarity index 100% rename from examples/json/AccountGetResponseExample.json rename to examples/json/AccountGetResponse.json diff --git a/examples/json/AccountUpdateRequestDefaultExample.json b/examples/json/AccountUpdateRequest.json similarity index 100% rename from examples/json/AccountUpdateRequestDefaultExample.json rename to examples/json/AccountUpdateRequest.json diff --git a/examples/json/AccountUpdateResponseExample.json b/examples/json/AccountUpdateResponse.json similarity index 100% rename from examples/json/AccountUpdateResponseExample.json rename to examples/json/AccountUpdateResponse.json diff --git a/examples/json/AccountVerifyFoundResponseExample.json b/examples/json/AccountVerifyFoundResponse.json similarity index 100% rename from examples/json/AccountVerifyFoundResponseExample.json rename to examples/json/AccountVerifyFoundResponse.json diff --git a/examples/json/AccountVerifyNotFoundResponseExample.json b/examples/json/AccountVerifyNotFoundResponse.json similarity index 100% rename from examples/json/AccountVerifyNotFoundResponseExample.json rename to examples/json/AccountVerifyNotFoundResponse.json diff --git a/examples/json/AccountVerifyRequestDefaultExample.json b/examples/json/AccountVerifyRequest.json similarity index 100% rename from examples/json/AccountVerifyRequestDefaultExample.json rename to examples/json/AccountVerifyRequest.json diff --git a/examples/json/ApiAppCreateRequestDefaultExample.json b/examples/json/ApiAppCreateRequest.json similarity index 88% rename from examples/json/ApiAppCreateRequestDefaultExample.json rename to examples/json/ApiAppCreateRequest.json index 2d5cd3c74..e21b53a74 100644 --- a/examples/json/ApiAppCreateRequestDefaultExample.json +++ b/examples/json/ApiAppCreateRequest.json @@ -1,5 +1,6 @@ { "name": "My Production App", + "custom_logo_file": "CustomLogoFile.png", "domains": [ "example.com" ], diff --git a/examples/json/ApiAppCreateResponseExample.json b/examples/json/ApiAppCreateResponse.json similarity index 100% rename from examples/json/ApiAppCreateResponseExample.json rename to examples/json/ApiAppCreateResponse.json diff --git a/examples/json/ApiAppGetResponseExample.json b/examples/json/ApiAppGetResponse.json similarity index 100% rename from examples/json/ApiAppGetResponseExample.json rename to examples/json/ApiAppGetResponse.json diff --git a/examples/json/ApiAppListResponseExample.json b/examples/json/ApiAppListResponse.json similarity index 100% rename from examples/json/ApiAppListResponseExample.json rename to examples/json/ApiAppListResponse.json diff --git a/examples/json/ApiAppUpdateRequest.json b/examples/json/ApiAppUpdateRequest.json new file mode 100644 index 000000000..3a06dbcf6 --- /dev/null +++ b/examples/json/ApiAppUpdateRequest.json @@ -0,0 +1,19 @@ +{ + "name": "New Name", + "callback_url": "https://example.com/dropboxsign", + "custom_logo_file": "CustomLogoFile.png", + "domains": [ + "example.com" + ], + "oauth": { + "callback_url": "https://example.com/oauth", + "scopes": [ + "basic_account_info", + "request_signature" + ] + }, + "white_labeling_options": { + "primary_button_color": "#00b3e6", + "primary_button_text_color": "#ffffff" + } +} diff --git a/examples/json/ApiAppUpdateRequestDefaultExample.json b/examples/json/ApiAppUpdateRequestDefaultExample.json deleted file mode 100644 index 7977b977e..000000000 --- a/examples/json/ApiAppUpdateRequestDefaultExample.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "name": "New Name", - "callback_url": "https://example.com/dropboxsign", - "white_labeling_options": { - "primary_button_color": "#00b3e6", - "primary_button_text_color": "#ffffff" - } -} diff --git a/examples/json/ApiAppUpdateResponseExample.json b/examples/json/ApiAppUpdateResponse.json similarity index 100% rename from examples/json/ApiAppUpdateResponseExample.json rename to examples/json/ApiAppUpdateResponse.json diff --git a/examples/json/BulkSendJobGetResponseExample.json b/examples/json/BulkSendJobGetResponse.json similarity index 100% rename from examples/json/BulkSendJobGetResponseExample.json rename to examples/json/BulkSendJobGetResponse.json diff --git a/examples/json/BulkSendJobListResponseExample.json b/examples/json/BulkSendJobListResponse.json similarity index 100% rename from examples/json/BulkSendJobListResponseExample.json rename to examples/json/BulkSendJobListResponse.json diff --git a/examples/json/EmbeddedEditUrlRequestDefaultExample.json b/examples/json/EmbeddedEditUrlRequest.json similarity index 100% rename from examples/json/EmbeddedEditUrlRequestDefaultExample.json rename to examples/json/EmbeddedEditUrlRequest.json diff --git a/examples/json/EmbeddedEditUrlResponseExample.json b/examples/json/EmbeddedEditUrlResponse.json similarity index 100% rename from examples/json/EmbeddedEditUrlResponseExample.json rename to examples/json/EmbeddedEditUrlResponse.json diff --git a/examples/json/EmbeddedSignUrlResponseExample.json b/examples/json/EmbeddedSignUrlResponse.json similarity index 100% rename from examples/json/EmbeddedSignUrlResponseExample.json rename to examples/json/EmbeddedSignUrlResponse.json diff --git a/examples/json/Error400ResponseExample.json b/examples/json/Error400Response.json similarity index 100% rename from examples/json/Error400ResponseExample.json rename to examples/json/Error400Response.json diff --git a/examples/json/Error401ResponseExample.json b/examples/json/Error401Response.json similarity index 100% rename from examples/json/Error401ResponseExample.json rename to examples/json/Error401Response.json diff --git a/examples/json/Error402ResponseExample.json b/examples/json/Error402Response.json similarity index 100% rename from examples/json/Error402ResponseExample.json rename to examples/json/Error402Response.json diff --git a/examples/json/Error403ResponseExample.json b/examples/json/Error403Response.json similarity index 100% rename from examples/json/Error403ResponseExample.json rename to examples/json/Error403Response.json diff --git a/examples/json/Error404ResponseExample.json b/examples/json/Error404Response.json similarity index 100% rename from examples/json/Error404ResponseExample.json rename to examples/json/Error404Response.json diff --git a/examples/json/Error409ResponseExample.json b/examples/json/Error409Response.json similarity index 100% rename from examples/json/Error409ResponseExample.json rename to examples/json/Error409Response.json diff --git a/examples/json/Error410ResponseExample.json b/examples/json/Error410Response.json similarity index 100% rename from examples/json/Error410ResponseExample.json rename to examples/json/Error410Response.json diff --git a/examples/json/Error422ResponseExample.json b/examples/json/Error422Response.json similarity index 100% rename from examples/json/Error422ResponseExample.json rename to examples/json/Error422Response.json diff --git a/examples/json/Error429ResponseExample.json b/examples/json/Error429Response.json similarity index 100% rename from examples/json/Error429ResponseExample.json rename to examples/json/Error429Response.json diff --git a/examples/json/Error4XXResponseExample.json b/examples/json/Error4XXResponse.json similarity index 100% rename from examples/json/Error4XXResponseExample.json rename to examples/json/Error4XXResponse.json diff --git a/examples/json/EventCallbackAccountSignatureRequestSentExample.json b/examples/json/EventCallbackAccountSignatureRequestSent.json similarity index 100% rename from examples/json/EventCallbackAccountSignatureRequestSentExample.json rename to examples/json/EventCallbackAccountSignatureRequestSent.json diff --git a/examples/json/EventCallbackAccountTemplateCreatedExample.json b/examples/json/EventCallbackAccountTemplateCreated.json similarity index 100% rename from examples/json/EventCallbackAccountTemplateCreatedExample.json rename to examples/json/EventCallbackAccountTemplateCreated.json diff --git a/examples/json/EventCallbackAppAccountConfirmedExample.json b/examples/json/EventCallbackAppAccountConfirmed.json similarity index 100% rename from examples/json/EventCallbackAppAccountConfirmedExample.json rename to examples/json/EventCallbackAppAccountConfirmed.json diff --git a/examples/json/EventCallbackAppSignatureRequestSentExample.json b/examples/json/EventCallbackAppSignatureRequestSent.json similarity index 100% rename from examples/json/EventCallbackAppSignatureRequestSentExample.json rename to examples/json/EventCallbackAppSignatureRequestSent.json diff --git a/examples/json/EventCallbackAppTemplateCreatedExample.json b/examples/json/EventCallbackAppTemplateCreated.json similarity index 100% rename from examples/json/EventCallbackAppTemplateCreatedExample.json rename to examples/json/EventCallbackAppTemplateCreated.json diff --git a/examples/json/FaxGetResponseExample.json b/examples/json/FaxGetResponse.json similarity index 100% rename from examples/json/FaxGetResponseExample.json rename to examples/json/FaxGetResponse.json diff --git a/examples/json/FaxLineAddUserRequestExample.json b/examples/json/FaxLineAddUserRequest.json similarity index 100% rename from examples/json/FaxLineAddUserRequestExample.json rename to examples/json/FaxLineAddUserRequest.json diff --git a/examples/json/FaxLineAreaCodeGetResponseExample.json b/examples/json/FaxLineAreaCodeGetResponse.json similarity index 100% rename from examples/json/FaxLineAreaCodeGetResponseExample.json rename to examples/json/FaxLineAreaCodeGetResponse.json diff --git a/examples/json/FaxLineCreateRequestExample.json b/examples/json/FaxLineCreateRequest.json similarity index 100% rename from examples/json/FaxLineCreateRequestExample.json rename to examples/json/FaxLineCreateRequest.json diff --git a/examples/json/FaxLineDeleteRequestExample.json b/examples/json/FaxLineDeleteRequest.json similarity index 100% rename from examples/json/FaxLineDeleteRequestExample.json rename to examples/json/FaxLineDeleteRequest.json diff --git a/examples/json/FaxLineListResponseExample.json b/examples/json/FaxLineListResponse.json similarity index 100% rename from examples/json/FaxLineListResponseExample.json rename to examples/json/FaxLineListResponse.json diff --git a/examples/json/FaxLineRemoveUserRequestExample.json b/examples/json/FaxLineRemoveUserRequest.json similarity index 100% rename from examples/json/FaxLineRemoveUserRequestExample.json rename to examples/json/FaxLineRemoveUserRequest.json diff --git a/examples/json/FaxLineResponseExample.json b/examples/json/FaxLineResponse.json similarity index 100% rename from examples/json/FaxLineResponseExample.json rename to examples/json/FaxLineResponse.json diff --git a/examples/json/FaxListResponseExample.json b/examples/json/FaxListResponse.json similarity index 100% rename from examples/json/FaxListResponseExample.json rename to examples/json/FaxListResponse.json diff --git a/examples/json/FaxSendRequestExample.json b/examples/json/FaxSendRequest.json similarity index 71% rename from examples/json/FaxSendRequestExample.json rename to examples/json/FaxSendRequest.json index 4b4ac16b3..7bfb88209 100644 --- a/examples/json/FaxSendRequestExample.json +++ b/examples/json/FaxSendRequest.json @@ -1,6 +1,6 @@ { - "file_urls": [ - "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + "files": [ + "./example_fax.pdf" ], "test_mode": "true", "recipient": "16690000001", diff --git a/examples/json/OAuthTokenGenerateRequestExample.json b/examples/json/OAuthTokenGenerateRequest.json similarity index 100% rename from examples/json/OAuthTokenGenerateRequestExample.json rename to examples/json/OAuthTokenGenerateRequest.json diff --git a/examples/json/OAuthTokenGenerateResponseExample.json b/examples/json/OAuthTokenGenerateResponse.json similarity index 100% rename from examples/json/OAuthTokenGenerateResponseExample.json rename to examples/json/OAuthTokenGenerateResponse.json diff --git a/examples/json/OAuthTokenRefreshRequestExample.json b/examples/json/OAuthTokenRefreshRequest.json similarity index 100% rename from examples/json/OAuthTokenRefreshRequestExample.json rename to examples/json/OAuthTokenRefreshRequest.json diff --git a/examples/json/OAuthTokenRefreshResponseExample.json b/examples/json/OAuthTokenRefreshResponse.json similarity index 100% rename from examples/json/OAuthTokenRefreshResponseExample.json rename to examples/json/OAuthTokenRefreshResponse.json diff --git a/examples/json/ReportCreateRequestDefaultExample.json b/examples/json/ReportCreateRequest.json similarity index 100% rename from examples/json/ReportCreateRequestDefaultExample.json rename to examples/json/ReportCreateRequest.json diff --git a/examples/json/ReportCreateResponseExample.json b/examples/json/ReportCreateResponse.json similarity index 100% rename from examples/json/ReportCreateResponseExample.json rename to examples/json/ReportCreateResponse.json diff --git a/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json diff --git a/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json b/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormData.json similarity index 100% rename from examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json rename to examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormData.json diff --git a/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json rename to examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json diff --git a/examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestBulkSendWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestBulkSendWithTemplateRequest.json diff --git a/examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json b/examples/json/SignatureRequestBulkSendWithTemplateRequestFormData.json similarity index 100% rename from examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json rename to examples/json/SignatureRequestBulkSendWithTemplateRequestFormData.json diff --git a/examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json b/examples/json/SignatureRequestBulkSendWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json rename to examples/json/SignatureRequestBulkSendWithTemplateResponse.json diff --git a/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json b/examples/json/SignatureRequestCreateEmbeddedRequest.json similarity index 88% rename from examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json rename to examples/json/SignatureRequestCreateEmbeddedRequest.json index 724db5940..ba7accb05 100644 --- a/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json +++ b/examples/json/SignatureRequestCreateEmbeddedRequest.json @@ -19,8 +19,8 @@ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "signing_options": { "draw": true, diff --git a/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json b/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json rename to examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestCreateEmbeddedResponseExample.json b/examples/json/SignatureRequestCreateEmbeddedResponse.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedResponseExample.json rename to examples/json/SignatureRequestCreateEmbeddedResponse.json diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json rename to examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json diff --git a/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json b/examples/json/SignatureRequestEditEmbeddedRequest.json similarity index 88% rename from examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json rename to examples/json/SignatureRequestEditEmbeddedRequest.json index 724db5940..ba7accb05 100644 --- a/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json +++ b/examples/json/SignatureRequestEditEmbeddedRequest.json @@ -19,8 +19,8 @@ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "signing_options": { "draw": true, diff --git a/examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json b/examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json rename to examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestEditEmbeddedResponseExample.json b/examples/json/SignatureRequestEditEmbeddedResponse.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedResponseExample.json rename to examples/json/SignatureRequestEditEmbeddedResponse.json diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json rename to examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json diff --git a/examples/json/SignatureRequestEditRequestDefaultExample.json b/examples/json/SignatureRequestEditRequest.json similarity index 89% rename from examples/json/SignatureRequestEditRequestDefaultExample.json rename to examples/json/SignatureRequestEditRequest.json index adfda81ec..3d1b98727 100644 --- a/examples/json/SignatureRequestEditRequestDefaultExample.json +++ b/examples/json/SignatureRequestEditRequest.json @@ -18,8 +18,8 @@ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "metadata": { "custom_id": 1234, diff --git a/examples/json/SignatureRequestEditRequestGroupedSignersExample.json b/examples/json/SignatureRequestEditRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestEditRequestGroupedSignersExample.json rename to examples/json/SignatureRequestEditRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestEditResponseExample.json b/examples/json/SignatureRequestEditResponse.json similarity index 100% rename from examples/json/SignatureRequestEditResponseExample.json rename to examples/json/SignatureRequestEditResponse.json diff --git a/examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestEditWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestEditWithTemplateRequest.json diff --git a/examples/json/SignatureRequestEditWithTemplateResponseExample.json b/examples/json/SignatureRequestEditWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestEditWithTemplateResponseExample.json rename to examples/json/SignatureRequestEditWithTemplateResponse.json diff --git a/examples/json/SignatureRequestFilesResponseExample.json b/examples/json/SignatureRequestFilesResponse.json similarity index 100% rename from examples/json/SignatureRequestFilesResponseExample.json rename to examples/json/SignatureRequestFilesResponse.json diff --git a/examples/json/SignatureRequestGetResponseExample.json b/examples/json/SignatureRequestGetResponse.json similarity index 100% rename from examples/json/SignatureRequestGetResponseExample.json rename to examples/json/SignatureRequestGetResponse.json diff --git a/examples/json/SignatureRequestListResponseExample.json b/examples/json/SignatureRequestListResponse.json similarity index 100% rename from examples/json/SignatureRequestListResponseExample.json rename to examples/json/SignatureRequestListResponse.json diff --git a/examples/json/SignatureRequestReleaseHoldResponseExample.json b/examples/json/SignatureRequestReleaseHoldResponse.json similarity index 100% rename from examples/json/SignatureRequestReleaseHoldResponseExample.json rename to examples/json/SignatureRequestReleaseHoldResponse.json diff --git a/examples/json/SignatureRequestRemindRequestDefaultExample.json b/examples/json/SignatureRequestRemindRequest.json similarity index 100% rename from examples/json/SignatureRequestRemindRequestDefaultExample.json rename to examples/json/SignatureRequestRemindRequest.json diff --git a/examples/json/SignatureRequestRemindResponseExample.json b/examples/json/SignatureRequestRemindResponse.json similarity index 100% rename from examples/json/SignatureRequestRemindResponseExample.json rename to examples/json/SignatureRequestRemindResponse.json diff --git a/examples/json/SignatureRequestSendRequestDefaultExample.json b/examples/json/SignatureRequestSendRequest.json similarity index 89% rename from examples/json/SignatureRequestSendRequestDefaultExample.json rename to examples/json/SignatureRequestSendRequest.json index adfda81ec..3d1b98727 100644 --- a/examples/json/SignatureRequestSendRequestDefaultExample.json +++ b/examples/json/SignatureRequestSendRequest.json @@ -18,8 +18,8 @@ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "metadata": { "custom_id": 1234, diff --git a/examples/json/SignatureRequestSendRequestGroupedSignersExample.json b/examples/json/SignatureRequestSendRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestSendRequestGroupedSignersExample.json rename to examples/json/SignatureRequestSendRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestSendResponseExample.json b/examples/json/SignatureRequestSendResponse.json similarity index 100% rename from examples/json/SignatureRequestSendResponseExample.json rename to examples/json/SignatureRequestSendResponse.json diff --git a/examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestSendWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestSendWithTemplateRequest.json diff --git a/examples/json/SignatureRequestSendWithTemplateResponseExample.json b/examples/json/SignatureRequestSendWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestSendWithTemplateResponseExample.json rename to examples/json/SignatureRequestSendWithTemplateResponse.json diff --git a/examples/json/SignatureRequestUpdateRequestDefaultExample.json b/examples/json/SignatureRequestUpdateRequest.json similarity index 100% rename from examples/json/SignatureRequestUpdateRequestDefaultExample.json rename to examples/json/SignatureRequestUpdateRequest.json diff --git a/examples/json/SignatureRequestUpdateResponseExample.json b/examples/json/SignatureRequestUpdateResponse.json similarity index 100% rename from examples/json/SignatureRequestUpdateResponseExample.json rename to examples/json/SignatureRequestUpdateResponse.json diff --git a/examples/json/TeamAddMemberRequestEmailAddressExample.json b/examples/json/TeamAddMemberRequest.json similarity index 100% rename from examples/json/TeamAddMemberRequestEmailAddressExample.json rename to examples/json/TeamAddMemberRequest.json diff --git a/examples/json/TeamAddMemberRequestAccountIdExample.json b/examples/json/TeamAddMemberRequestAccountId.json similarity index 100% rename from examples/json/TeamAddMemberRequestAccountIdExample.json rename to examples/json/TeamAddMemberRequestAccountId.json diff --git a/examples/json/TeamAddMemberResponseExample.json b/examples/json/TeamAddMemberResponse.json similarity index 100% rename from examples/json/TeamAddMemberResponseExample.json rename to examples/json/TeamAddMemberResponse.json diff --git a/examples/json/TeamCreateRequestDefaultExample.json b/examples/json/TeamCreateRequest.json similarity index 100% rename from examples/json/TeamCreateRequestDefaultExample.json rename to examples/json/TeamCreateRequest.json diff --git a/examples/json/TeamCreateResponseExample.json b/examples/json/TeamCreateResponse.json similarity index 100% rename from examples/json/TeamCreateResponseExample.json rename to examples/json/TeamCreateResponse.json diff --git a/examples/json/TeamDoesNotExistResponseExample.json b/examples/json/TeamDoesNotExistResponse.json similarity index 100% rename from examples/json/TeamDoesNotExistResponseExample.json rename to examples/json/TeamDoesNotExistResponse.json diff --git a/examples/json/TeamGetInfoResponseExample.json b/examples/json/TeamGetInfoResponse.json similarity index 100% rename from examples/json/TeamGetInfoResponseExample.json rename to examples/json/TeamGetInfoResponse.json diff --git a/examples/json/TeamGetResponseExample.json b/examples/json/TeamGetResponse.json similarity index 100% rename from examples/json/TeamGetResponseExample.json rename to examples/json/TeamGetResponse.json diff --git a/examples/json/TeamGetRootInfoResponseExample.json b/examples/json/TeamGetRootInfoResponse.json similarity index 100% rename from examples/json/TeamGetRootInfoResponseExample.json rename to examples/json/TeamGetRootInfoResponse.json diff --git a/examples/json/TeamInvitesResponseExample.json b/examples/json/TeamInvitesResponse.json similarity index 100% rename from examples/json/TeamInvitesResponseExample.json rename to examples/json/TeamInvitesResponse.json diff --git a/examples/json/TeamMembersResponseExample.json b/examples/json/TeamMembersResponse.json similarity index 100% rename from examples/json/TeamMembersResponseExample.json rename to examples/json/TeamMembersResponse.json diff --git a/examples/json/TeamRemoveMemberRequestEmailAddressExample.json b/examples/json/TeamRemoveMemberRequest.json similarity index 100% rename from examples/json/TeamRemoveMemberRequestEmailAddressExample.json rename to examples/json/TeamRemoveMemberRequest.json diff --git a/examples/json/TeamRemoveMemberRequestAccountIdExample.json b/examples/json/TeamRemoveMemberRequestAccountId.json similarity index 100% rename from examples/json/TeamRemoveMemberRequestAccountIdExample.json rename to examples/json/TeamRemoveMemberRequestAccountId.json diff --git a/examples/json/TeamRemoveMemberResponseExample.json b/examples/json/TeamRemoveMemberResponse.json similarity index 100% rename from examples/json/TeamRemoveMemberResponseExample.json rename to examples/json/TeamRemoveMemberResponse.json diff --git a/examples/json/TeamSubTeamsResponseExample.json b/examples/json/TeamSubTeamsResponse.json similarity index 100% rename from examples/json/TeamSubTeamsResponseExample.json rename to examples/json/TeamSubTeamsResponse.json diff --git a/examples/json/TeamUpdateRequestDefaultExample.json b/examples/json/TeamUpdateRequest.json similarity index 100% rename from examples/json/TeamUpdateRequestDefaultExample.json rename to examples/json/TeamUpdateRequest.json diff --git a/examples/json/TeamUpdateResponseExample.json b/examples/json/TeamUpdateResponse.json similarity index 100% rename from examples/json/TeamUpdateResponseExample.json rename to examples/json/TeamUpdateResponse.json diff --git a/examples/json/TemplateAddUserRequestDefaultExample.json b/examples/json/TemplateAddUserRequest.json similarity index 100% rename from examples/json/TemplateAddUserRequestDefaultExample.json rename to examples/json/TemplateAddUserRequest.json diff --git a/examples/json/TemplateAddUserResponseExample.json b/examples/json/TemplateAddUserResponse.json similarity index 100% rename from examples/json/TemplateAddUserResponseExample.json rename to examples/json/TemplateAddUserResponse.json diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json b/examples/json/TemplateCreateEmbeddedDraftRequest.json similarity index 85% rename from examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequest.json index 10f895fe8..68c71abe1 100644 --- a/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json +++ b/examples/json/TemplateCreateEmbeddedDraftRequest.json @@ -1,7 +1,7 @@ { "client_id": "37dee8d8440c66d54cfa05d92c160882", - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "title": "Test Template", "subject": "Please sign this document", diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json diff --git a/examples/json/TemplateCreateEmbeddedDraftResponseExample.json b/examples/json/TemplateCreateEmbeddedDraftResponse.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftResponseExample.json rename to examples/json/TemplateCreateEmbeddedDraftResponse.json diff --git a/examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json b/examples/json/TemplateCreateRequest.json similarity index 92% rename from examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json rename to examples/json/TemplateCreateRequest.json index a3709afcc..b18275f8a 100644 --- a/examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json +++ b/examples/json/TemplateCreateRequest.json @@ -1,7 +1,7 @@ { "client_id": "37dee8d8440c66d54cfa05d92c160882", - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "title": "Test Template", "subject": "Please sign this document", diff --git a/examples/json/TemplateCreateRequestFormFieldGroupsExample.json b/examples/json/TemplateCreateRequestFormFieldGroups.json similarity index 100% rename from examples/json/TemplateCreateRequestFormFieldGroupsExample.json rename to examples/json/TemplateCreateRequestFormFieldGroups.json diff --git a/examples/json/TemplateCreateRequestFormFieldRulesExample.json b/examples/json/TemplateCreateRequestFormFieldRules.json similarity index 100% rename from examples/json/TemplateCreateRequestFormFieldRulesExample.json rename to examples/json/TemplateCreateRequestFormFieldRules.json diff --git a/examples/json/TemplateCreateRequestDefaultExample.json b/examples/json/TemplateCreateRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/TemplateCreateRequestDefaultExample.json rename to examples/json/TemplateCreateRequestFormFieldsPerDocument.json diff --git a/examples/json/TemplateCreateResponseExample.json b/examples/json/TemplateCreateResponse.json similarity index 100% rename from examples/json/TemplateCreateResponseExample.json rename to examples/json/TemplateCreateResponse.json diff --git a/examples/json/TemplateFilesResponseExample.json b/examples/json/TemplateFilesResponse.json similarity index 100% rename from examples/json/TemplateFilesResponseExample.json rename to examples/json/TemplateFilesResponse.json diff --git a/examples/json/TemplateGetResponseExample.json b/examples/json/TemplateGetResponse.json similarity index 100% rename from examples/json/TemplateGetResponseExample.json rename to examples/json/TemplateGetResponse.json diff --git a/examples/json/TemplateListResponseExample.json b/examples/json/TemplateListResponse.json similarity index 100% rename from examples/json/TemplateListResponseExample.json rename to examples/json/TemplateListResponse.json diff --git a/examples/json/TemplateRemoveUserRequestDefaultExample.json b/examples/json/TemplateRemoveUserRequest.json similarity index 100% rename from examples/json/TemplateRemoveUserRequestDefaultExample.json rename to examples/json/TemplateRemoveUserRequest.json diff --git a/examples/json/TemplateRemoveUserResponseExample.json b/examples/json/TemplateRemoveUserResponse.json similarity index 100% rename from examples/json/TemplateRemoveUserResponseExample.json rename to examples/json/TemplateRemoveUserResponse.json diff --git a/examples/json/TemplateUpdateFilesRequest.json b/examples/json/TemplateUpdateFilesRequest.json new file mode 100644 index 000000000..120e168a6 --- /dev/null +++ b/examples/json/TemplateUpdateFilesRequest.json @@ -0,0 +1,5 @@ +{ + "files": [ + "./example_signature_request.pdf" + ] +} diff --git a/examples/json/TemplateUpdateFilesRequestDefaultExample.json b/examples/json/TemplateUpdateFilesRequestDefaultExample.json deleted file mode 100644 index 88c101579..000000000 --- a/examples/json/TemplateUpdateFilesRequestDefaultExample.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" - ] -} diff --git a/examples/json/TemplateUpdateFilesResponseExample.json b/examples/json/TemplateUpdateFilesResponse.json similarity index 100% rename from examples/json/TemplateUpdateFilesResponseExample.json rename to examples/json/TemplateUpdateFilesResponse.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequest.json similarity index 60% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequest.json index ae9f61ad6..9f8c02387 100644 --- a/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json +++ b/examples/json/UnclaimedDraftCreateEmbeddedRequest.json @@ -1,7 +1,7 @@ { "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "requester_email_address": "jack@dropboxsign.com", "test_mode": true diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json b/examples/json/UnclaimedDraftCreateEmbeddedResponse.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedResponse.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json b/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json diff --git a/examples/json/UnclaimedDraftCreateRequestDefaultExample.json b/examples/json/UnclaimedDraftCreateRequest.json similarity index 65% rename from examples/json/UnclaimedDraftCreateRequestDefaultExample.json rename to examples/json/UnclaimedDraftCreateRequest.json index 5ed2ca115..21707bde1 100644 --- a/examples/json/UnclaimedDraftCreateRequestDefaultExample.json +++ b/examples/json/UnclaimedDraftCreateRequest.json @@ -1,6 +1,6 @@ { - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + "files": [ + "./example_signature_request.pdf" ], "signers": [ { diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json similarity index 100% rename from examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json rename to examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldRules.json similarity index 100% rename from examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json rename to examples/json/UnclaimedDraftCreateRequestFormFieldRules.json diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json rename to examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json diff --git a/examples/json/UnclaimedDraftCreateResponseExample.json b/examples/json/UnclaimedDraftCreateResponse.json similarity index 100% rename from examples/json/UnclaimedDraftCreateResponseExample.json rename to examples/json/UnclaimedDraftCreateResponse.json diff --git a/examples/json/UnclaimedDraftEditAndResendExample.json b/examples/json/UnclaimedDraftEditAndResend.json similarity index 100% rename from examples/json/UnclaimedDraftEditAndResendExample.json rename to examples/json/UnclaimedDraftEditAndResend.json diff --git a/examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json b/examples/json/UnclaimedDraftEditAndResendRequest.json similarity index 100% rename from examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json rename to examples/json/UnclaimedDraftEditAndResendRequest.json diff --git a/generate-sdks b/generate-sdks index fe899ab18..de40ae11b 100755 --- a/generate-sdks +++ b/generate-sdks @@ -155,18 +155,17 @@ function copy_examples() mkdir -p "${SDK_DIR}/examples" if [[ "${SDK}" == "dotnet" ]]; then - cp -r "${DIR}/examples/"*.cs "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox/"*.cs "${SDK_DIR}/examples/" elif [[ "${SDK}" == "java-v2" || "${SDK}" == "java-v1" ]]; then - cp -r "${DIR}/examples/"*.java "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox/"*.java "${SDK_DIR}/examples/" elif [[ "${SDK}" == "node" ]]; then - cp -r "${DIR}/examples/"*.js "${SDK_DIR}/examples/" - cp -r "${DIR}/examples/"*.ts "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/node/src/"*.ts "${SDK_DIR}/examples/" elif [[ "${SDK}" == "php" ]]; then - cp -r "${DIR}/examples/"*.php "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/php/src/"*.php "${SDK_DIR}/examples/" elif [[ "${SDK}" == "python" ]]; then - cp -r "${DIR}/examples/"*.py "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/python/src/"*.py "${SDK_DIR}/examples/" elif [[ "${SDK}" == "ruby" ]]; then - cp -r "${DIR}/examples/"*.rb "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/ruby/src/"*.rb "${SDK_DIR}/examples/" fi } diff --git a/openapi-raw.yaml b/openapi-raw.yaml index b03c3d48d..64611ce29 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -27,10 +27,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: '200': description: 'successful operation' @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' 4XX: description: failed_operation content: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: '_t__AccountCreate::SEO::TITLE' @@ -155,8 +150,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' + example: + $ref: '#/components/examples/AccountGetResponse' 4XX: description: failed_operation content: @@ -165,15 +160,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -186,42 +181,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: '_t__AccountGet::SEO::TITLE' @@ -239,8 +229,8 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: '200': description: 'successful operation' @@ -256,8 +246,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' + example: + $ref: '#/components/examples/AccountUpdateResponse' 4XX: description: failed_operation content: @@ -266,17 +256,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -288,42 +278,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: '_t__AccountUpdate::SEO::TITLE' @@ -342,8 +327,8 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: '200': description: 'successful operation' @@ -359,10 +344,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' 4XX: description: failed_operation content: @@ -371,15 +356,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -391,42 +376,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: '_t__AccountVerify::SEO::TITLE' @@ -445,8 +425,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' @@ -465,8 +445,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' + example: + $ref: '#/components/examples/ApiAppCreateResponse' 4XX: description: failed_operation content: @@ -475,17 +455,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -497,42 +477,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: '_t__ApiAppCreate::SEO::TITLE' @@ -568,8 +543,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' + example: + $ref: '#/components/examples/ApiAppGetResponse' 4XX: description: failed_operation content: @@ -578,19 +553,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -602,42 +577,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: '_t__ApiAppGet::SEO::TITLE' @@ -664,8 +634,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' @@ -684,8 +654,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' + example: + $ref: '#/components/examples/ApiAppUpdateResponse' 4XX: description: failed_operation content: @@ -694,19 +664,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -718,42 +688,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: '_t__ApiAppUpdate::SEO::TITLE' @@ -791,17 +756,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -813,42 +778,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: '_t__ApiAppDelete::SEO::TITLE' @@ -890,8 +850,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' + example: + $ref: '#/components/examples/ApiAppListResponse' 4XX: description: failed_operation content: @@ -900,15 +860,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -920,42 +880,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: '_t__ApiAppList::SEO::TITLE' @@ -1005,8 +960,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' + example: + $ref: '#/components/examples/BulkSendJobGetResponse' 4XX: description: failed_operation content: @@ -1015,15 +970,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1036,42 +991,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: '_t__BulkSendJobGet::SEO::TITLE' @@ -1113,8 +1063,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' + example: + $ref: '#/components/examples/BulkSendJobListResponse' 4XX: description: failed_operation content: @@ -1123,15 +1073,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1144,42 +1094,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: '_t__BulkSendJobList::SEO::TITLE' @@ -1207,8 +1152,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: '200': description: 'successful operation' @@ -1224,8 +1169,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' 4XX: description: failed_operation content: @@ -1234,17 +1179,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1256,42 +1201,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: '_t__EmbeddedEditUrl::SEO::TITLE' @@ -1327,8 +1267,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' 4XX: description: failed_operation content: @@ -1337,21 +1277,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1363,42 +1303,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: '_t__EmbeddedSignUrl::SEO::TITLE' @@ -1434,8 +1369,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' 4XX: description: failed_operation content: @@ -1444,19 +1379,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1465,42 +1400,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: '_t__FaxGet::SEO::TITLE' @@ -1538,19 +1468,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1559,42 +1489,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: '_t__FaxDelete::SEO::TITLE' @@ -1638,21 +1563,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1661,42 +1586,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: '_t__FaxFiles::SEO::TITLE' @@ -1715,8 +1635,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: '200': description: 'successful operation' @@ -1732,8 +1652,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -1742,17 +1662,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1761,42 +1681,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: '_t__FaxLineAddUser::SEO::TITLE' @@ -1820,6 +1735,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -1919,8 +1835,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' 4XX: description: failed_operation content: @@ -1929,15 +1845,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1946,42 +1862,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: '_t__FaxLineAreaCodeGet::SEO::TITLE' @@ -2000,8 +1911,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: '200': description: 'successful operation' @@ -2017,8 +1928,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -2027,17 +1938,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2046,42 +1957,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: '_t__FaxLineCreate::SEO::TITLE' @@ -2101,6 +2007,7 @@ paths: required: true schema: type: string + example: 123-123-1234 responses: '200': description: 'successful operation' @@ -2116,8 +2023,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -2126,17 +2033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2145,42 +2052,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: '_t__FaxLineGet::SEO::TITLE' @@ -2198,8 +2100,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: '200': description: 'successful operation' @@ -2220,17 +2122,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2239,42 +2141,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: '_t__FaxLineDelete::SEO::TITLE' @@ -2293,7 +2190,7 @@ paths: description: '_t__FaxLineList::ACCOUNT_ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2301,7 +2198,7 @@ paths: schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query @@ -2309,7 +2206,7 @@ paths: schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query @@ -2331,8 +2228,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + example: + $ref: '#/components/examples/FaxLineListResponse' 4XX: description: failed_operation content: @@ -2341,15 +2238,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2358,42 +2255,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: '_t__FaxLineList::SEO::TITLE' @@ -2412,8 +2304,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: '200': description: 'successful operation' @@ -2429,8 +2321,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -2439,17 +2331,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2458,42 +2350,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: '_t__FaxLineRemoveUser::SEO::TITLE' @@ -2540,8 +2427,8 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' + example: + $ref: '#/components/examples/FaxListResponse' 4XX: description: failed_operation content: @@ -2550,15 +2437,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2567,42 +2454,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: '_t__FaxList::SEO::TITLE' @@ -2621,8 +2503,8 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' @@ -2641,8 +2523,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' 4XX: description: failed_operation content: @@ -2651,19 +2533,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2672,42 +2554,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: title: '_t__FaxSend::SEO::TITLE' @@ -2726,8 +2603,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: '200': description: 'successful operation' @@ -2743,8 +2620,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' 4XX: description: failed_operation content: @@ -2753,15 +2630,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2771,42 +2648,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: '_t__OAuthTokenGenerate::SEO::TITLE' @@ -2826,8 +2698,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: '200': description: 'successful operation' @@ -2843,8 +2715,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' 4XX: description: failed_operation content: @@ -2853,15 +2725,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2871,42 +2743,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: '_t__OAuthTokenRefresh::SEO::TITLE' @@ -2926,8 +2793,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: '200': description: 'successful operation' @@ -2943,8 +2810,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' + example: + $ref: '#/components/examples/ReportCreateResponse' 4XX: description: failed_operation content: @@ -2953,15 +2820,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2970,42 +2837,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: '_t__ReportCreate::SEO::TITLE' @@ -3024,8 +2886,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' @@ -3044,8 +2906,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -3054,21 +2916,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3077,42 +2939,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE' @@ -3131,8 +2988,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' @@ -3151,8 +3008,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' 4XX: description: failed_operation content: @@ -3161,17 +3018,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3184,42 +3041,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestBulkSendWithTemplate::SEO::TITLE' @@ -3260,21 +3112,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3287,42 +3139,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: '_t__SignatureRequestCancel::SEO::TITLE' @@ -3341,10 +3188,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' @@ -3363,8 +3210,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' 4XX: description: failed_operation content: @@ -3373,19 +3220,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3397,42 +3244,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: '_t__SignatureRequestCreateEmbedded::SEO::TITLE' @@ -3451,8 +3293,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' @@ -3471,8 +3313,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -3481,19 +3323,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3505,42 +3347,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE' @@ -3568,10 +3405,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' @@ -3590,8 +3427,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditResponse' 4XX: description: failed_operation content: @@ -3600,21 +3437,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3627,42 +3464,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEdit.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEdit.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEdit.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEdit.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEdit.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEdit.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEdit.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEdit.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: title: '_t__SignatureRequestEdit::SEO::TITLE' @@ -3692,10 +3524,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' @@ -3714,8 +3546,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedResponse' 4XX: description: failed_operation content: @@ -3724,21 +3556,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3750,42 +3582,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbedded.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbedded.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbedded.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbedded.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbedded.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbedded.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbedded.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: title: '_t__SignatureRequestEditEmbedded::SEO::TITLE' @@ -3815,8 +3642,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' @@ -3835,8 +3662,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -3845,21 +3672,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3871,42 +3698,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE' @@ -3936,8 +3758,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' @@ -3956,8 +3778,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateResponse' 4XX: description: failed_operation content: @@ -3966,21 +3788,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,42 +3815,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditWithTemplate.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditWithTemplate.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditWithTemplate.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditWithTemplate.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditWithTemplate.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditWithTemplate.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditWithTemplate.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE' @@ -4088,23 +3905,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4117,42 +3934,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' @@ -4188,8 +4000,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' 4XX: description: failed_operation content: @@ -4198,23 +4010,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4227,42 +4039,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' @@ -4305,8 +4112,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' 4XX: description: failed_operation content: @@ -4315,23 +4122,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,42 +4151,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' @@ -4415,8 +4217,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + example: + $ref: '#/components/examples/SignatureRequestGetResponse' 4XX: description: failed_operation content: @@ -4425,19 +4227,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4450,42 +4252,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: title: '_t__SignatureRequestGet::SEO::TITLE' @@ -4540,8 +4337,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + example: + $ref: '#/components/examples/SignatureRequestListResponse' 4XX: description: failed_operation content: @@ -4550,17 +4347,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4573,42 +4370,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: title: '_t__SignatureRequestList::SEO::TITLE' @@ -4644,8 +4436,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' 4XX: description: failed_operation content: @@ -4654,17 +4446,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4676,42 +4468,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: title: '_t__SignatureRequestReleaseHold::SEO::TITLE' @@ -4739,8 +4526,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: '200': description: 'successful operation' @@ -4756,8 +4543,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' 4XX: description: failed_operation content: @@ -4766,23 +4553,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4795,42 +4582,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: title: '_t__SignatureRequestRemind::SEO::TITLE' @@ -4871,21 +4653,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4894,42 +4676,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: title: '_t__SignatureRequestRemove::SEO::TITLE' @@ -4948,10 +4725,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' @@ -4970,8 +4747,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendResponse' 4XX: description: failed_operation content: @@ -4980,19 +4757,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5005,42 +4782,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: title: '_t__SignatureRequestSend::SEO::TITLE' @@ -5059,8 +4831,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' @@ -5079,8 +4851,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' 4XX: description: failed_operation content: @@ -5089,17 +4861,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5112,42 +4884,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestSendWithTemplate::SEO::TITLE' @@ -5175,8 +4942,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: '200': description: 'successful operation' @@ -5192,8 +4959,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' 4XX: description: failed_operation content: @@ -5202,17 +4969,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5224,42 +4991,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: title: '_t__SignatureRequestUpdate::SEO::TITLE' @@ -5287,10 +5049,10 @@ paths: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: '200': description: 'successful operation' @@ -5306,8 +5068,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + example: + $ref: '#/components/examples/TeamAddMemberResponse' 4XX: description: failed_operation content: @@ -5316,17 +5078,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5338,42 +5100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: title: '_t__TeamAddMember::SEO::TITLE' @@ -5392,8 +5149,8 @@ paths: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamCreateRequest' responses: '200': description: 'successful operation' @@ -5409,8 +5166,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + example: + $ref: '#/components/examples/TeamCreateResponse' 4XX: description: failed_operation content: @@ -5419,15 +5176,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5439,42 +5196,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: title: '_t__TeamCreate::SEO::TITLE' @@ -5504,15 +5256,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5524,42 +5276,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: title: '_t__TeamDelete::SEO::TITLE' @@ -5586,8 +5333,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' + example: + $ref: '#/components/examples/TeamGetResponse' 4XX: description: failed_operation content: @@ -5596,17 +5343,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5618,42 +5365,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/TeamGetExample.sh x-meta: seo: title: '_t__TeamGet::SEO::TITLE' @@ -5671,8 +5413,8 @@ paths: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: '200': description: 'successful operation' @@ -5688,8 +5430,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + example: + $ref: '#/components/examples/TeamUpdateResponse' 4XX: description: failed_operation content: @@ -5698,15 +5440,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5718,42 +5460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: title: '_t__TeamUpdate::SEO::TITLE' @@ -5789,8 +5526,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + example: + $ref: '#/components/examples/TeamGetInfoResponse' 4XX: description: failed_operation content: @@ -5799,19 +5536,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5823,42 +5560,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: title: '_t__TeamInfo::SEO::TITLE' @@ -5893,8 +5625,8 @@ paths: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' + example: + $ref: '#/components/examples/TeamInvitesResponse' 4XX: description: failed_operation content: @@ -5903,15 +5635,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5924,42 +5656,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: title: '_t__TeamInvites::SEO::TITLE' @@ -6011,8 +5738,8 @@ paths: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + example: + $ref: '#/components/examples/TeamMembersResponse' 4XX: description: failed_operation content: @@ -6021,19 +5748,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6045,42 +5772,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: title: '_t__TeamMembers::SEO::TITLE' @@ -6099,10 +5821,10 @@ paths: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: '201': description: 'successful operation' @@ -6118,8 +5840,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' 4XX: description: failed_operation content: @@ -6128,17 +5850,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6150,42 +5872,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: title: '_t__TeamRemoveMember::SEO::TITLE' @@ -6237,8 +5954,8 @@ paths: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + example: + $ref: '#/components/examples/TeamSubTeamsResponse' 4XX: description: failed_operation content: @@ -6247,19 +5964,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6271,42 +5988,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: title: '_t__TeamSubTeams::SEO::TITLE' @@ -6334,8 +6046,8 @@ paths: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: '200': description: 'successful operation' @@ -6351,8 +6063,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + example: + $ref: '#/components/examples/TemplateAddUserResponse' 4XX: description: failed_operation content: @@ -6361,17 +6073,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6383,42 +6095,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: title: '_t__TemplateAddUser::SEO::TITLE' @@ -6437,14 +6144,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' @@ -6463,8 +6170,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + example: + $ref: '#/components/examples/TemplateCreateResponse' 4XX: description: failed_operation content: @@ -6473,19 +6180,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6497,42 +6204,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: title: '_t__TemplateCreate::SEO::TITLE' @@ -6551,14 +6253,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' @@ -6577,8 +6279,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' 4XX: description: failed_operation content: @@ -6587,19 +6289,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6611,42 +6313,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: title: '_t__TemplateCreateEmbeddedDraft::SEO::TITLE' @@ -6687,19 +6384,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6711,42 +6408,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: title: '_t__TemplateDelete::SEO::TITLE' @@ -6803,23 +6495,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6831,42 +6523,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' @@ -6902,8 +6589,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' 4XX: description: failed_operation content: @@ -6912,23 +6599,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6940,42 +6627,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' @@ -7018,8 +6700,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' 4XX: description: failed_operation content: @@ -7028,23 +6710,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7056,42 +6738,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' @@ -7127,8 +6804,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + example: + $ref: '#/components/examples/TemplateGetResponse' 4XX: description: failed_operation content: @@ -7137,19 +6814,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7161,42 +6838,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: title: '_t__TemplateGet::SEO::TITLE' @@ -7252,8 +6924,8 @@ paths: schema: $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + example: + $ref: '#/components/examples/TemplateListResponse' 4XX: description: failed_operation content: @@ -7262,19 +6934,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7286,42 +6958,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateListExample.sh x-meta: seo: title: '_t__TemplateList::SEO::TITLE' @@ -7349,8 +7016,8 @@ paths: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: '200': description: 'successful operation' @@ -7366,8 +7033,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' 4XX: description: failed_operation content: @@ -7376,17 +7043,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7398,42 +7065,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: title: '_t__TemplateRemoveUser::SEO::TITLE' @@ -7461,8 +7123,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' @@ -7481,8 +7143,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' 4XX: description: failed_operation content: @@ -7491,21 +7153,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7517,42 +7179,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateUpdateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateUpdateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateUpdateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateUpdateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateUpdateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: title: '_t__TemplateUpdateFiles::SEO::TITLE' @@ -7571,14 +7228,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' @@ -7597,8 +7254,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' 4XX: description: failed_operation content: @@ -7607,15 +7264,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7627,42 +7284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/UnclaimedDraftCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: title: '_t__UnclaimedDraftCreate::SEO::TITLE' @@ -7681,14 +7333,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' @@ -7707,8 +7359,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' 4XX: description: failed_operation content: @@ -7717,19 +7369,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7742,42 +7394,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: title: '_t__UnclaimedDraftCreateEmbedded::SEO::TITLE' @@ -7796,8 +7443,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' @@ -7816,8 +7463,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -7826,21 +7473,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7852,42 +7499,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE' @@ -7915,8 +7557,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' responses: '200': description: 'successful operation' @@ -7932,8 +7574,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' 4XX: description: failed_operation content: @@ -7942,21 +7584,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7969,42 +7611,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftEditAndResendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftEditAndResendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftEditAndResendExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftEditAndResendExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftEditAndResendExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftEditAndResendExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: title: '_t__UnclaimedDraftEditAndResend::SEO::TITLE' @@ -13171,522 +12808,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditRequestDefaultExample.json - SignatureRequestEditRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json - SignatureRequestEditEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: '_t__AccountCreateResponseExample::SUMMARY' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: '_t__AccountCreateOAuthResponseExample::SUMMARY' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: '_t__AccountGetResponseExample::SUMMARY' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: '_t__AccountVerifyFoundResponseExample::SUMMARY' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: '_t__AccountVerifyNotFoundResponseExample::SUMMARY' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: '_t__ApiAppGetResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: '_t__ApiAppListResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: '_t__BulkSendJobGetResponseExample::SUMMARY' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: '_t__BulkSendJobListResponseExample::SUMMARY' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: '_t__EmbeddedEditUrlResponseExample::SUMMARY' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: '_t__EmbeddedSignUrlResponseExample::SUMMARY' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: '_t__Error::400' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: '_t__Error::401' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: '_t__Error::402' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: '_t__Error::403' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: '_t__Error::404' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: '_t__Error::409' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: '_t__Error::410' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: '_t__Error::422' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: '_t__Error::429' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: '_t__Error::4XX' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: '_t__FaxGetResponseExample::SUMMARY' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: '_t__FaxLineResponseExample::SUMMARY' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: '_t__FaxLineAreaCodeGetResponseExample::SUMMARY' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: '_t__FaxLineListResponseExample::SUMMARY' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: summary: '_t__FaxListResponseExample::SUMMARY' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: '_t__ReportCreateResponseExample::SUMMARY' value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: '_t__SignatureRequestGetResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: '_t__SignatureRequestListResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: '_t__AccountUpdateResponseExample::SUMMARY' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: '_t__OAuthTokenGenerateResponseExample::SUMMARY' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: '_t__OAuthTokenRefreshResponseExample::SUMMARY' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: '_t__ApiAppCreateResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: '_t__ApiAppUpdateResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: '_t__SignatureRequestCreateEmbeddedResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: '_t__SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: '_t__SignatureRequestFilesResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: '_t__SignatureRequestReleaseHoldResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: '_t__SignatureRequestRemindResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: '_t__SignatureRequestSendResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: '_t__SignatureRequestSendWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: '_t__SignatureRequestUpdateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: '_t__SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: '_t__SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: '_t__TeamCreateResponseExample::SUMMARY' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: '_t__TeamMembersResponseExample::SUMMARY' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: '_t__TeamRemoveMemberResponseExample::SUMMARY' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: '_t__TeamUpdateResponseExample::SUMMARY' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: '_t__TeamDoesNotExistResponseExample::SUMMARY' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: '_t__TemplateAddUserResponseExample::SUMMARY' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: '_t__TemplateFilesResponseExample::SUMMARY' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: '_t__TemplateRemoveUserResponseExample::SUMMARY' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: '_t__UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: '_t__UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: '_t__UnclaimedDraftEditAndResendExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: '_t__TeamGetResponseExample::SUMMARY' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: '_t__TeamInfoResponseExample::SUMMARY' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: '_t__TeamInvitesResponseExample::SUMMARY' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: '_t__TeamAddMemberResponseExample::SUMMARY' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: '_t__TeamSubTeamsResponseExample::SUMMARY' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: '_t__TemplateCreateResponseExample::SUMMARY' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: '_t__TemplateCreateEmbeddedDraftResponseExample::SUMMARY' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: '_t__TemplateGetResponseExample::SUMMARY' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: '_t__TemplateListResponseExample::SUMMARY' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: '_t__TemplateUpdateFilesResponseExample::SUMMARY' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: '_t__UnclaimedDraftCreateResponseExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: '_t__EventCallbackAccountSignatureRequestSentExample::SUMMARY' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: '_t__EventCallbackAccountTemplateCreatedExample::SUMMARY' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: '_t__EventCallbackAppAccountConfirmedExample::SUMMARY' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: '_t__EventCallbackAppSignatureRequestSentExample::SUMMARY' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: '_t__EventCallbackAppTemplateCreatedExample::SUMMARY' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: '_t__EventCallbackAccountRequest::DESCRIPTION' @@ -13696,9 +13333,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: '_t__EventCallbackAppRequest::DESCRIPTION' content: @@ -13707,11 +13344,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: '_t__Common::RateLimiting::LIMIT' @@ -13744,6 +13381,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -13807,37 +13445,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -13859,37 +13492,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 8b67ae6a9..a3615bf24 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -27,10 +27,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: '200': description: 'successful operation' @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' '4XX': description: failed_operation content: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -161,8 +156,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' + example: + $ref: '#/components/examples/AccountGetResponse' '4XX': description: failed_operation content: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,8 +235,8 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: '200': description: 'successful operation' @@ -262,8 +252,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' + example: + $ref: '#/components/examples/AccountUpdateResponse' '4XX': description: failed_operation content: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,8 +333,8 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: '200': description: 'successful operation' @@ -365,10 +350,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' '4XX': description: failed_operation content: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,8 +431,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' @@ -471,8 +451,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' + example: + $ref: '#/components/examples/ApiAppCreateResponse' '4XX': description: failed_operation content: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -574,8 +549,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' + example: + $ref: '#/components/examples/ApiAppGetResponse' '4XX': description: failed_operation content: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,8 +640,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' @@ -690,8 +660,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' + example: + $ref: '#/components/examples/ApiAppUpdateResponse' '4XX': description: failed_operation content: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -896,8 +856,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' + example: + $ref: '#/components/examples/ApiAppListResponse' '4XX': description: failed_operation content: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -1011,8 +966,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' + example: + $ref: '#/components/examples/BulkSendJobGetResponse' '4XX': description: failed_operation content: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1119,8 +1069,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' + example: + $ref: '#/components/examples/BulkSendJobListResponse' '4XX': description: failed_operation content: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,8 +1158,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: '200': description: 'successful operation' @@ -1230,8 +1175,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' '4XX': description: failed_operation content: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1333,8 +1273,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' '4XX': description: failed_operation content: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1440,8 +1375,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,42 +1406,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,42 +1592,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' @@ -1721,8 +1641,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: '200': description: 'successful operation' @@ -1738,8 +1658,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1826,6 +1741,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -1925,8 +1841,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' '4XX': description: failed_operation content: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,42 +1868,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' @@ -2006,8 +1917,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: '200': description: 'successful operation' @@ -2023,8 +1934,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2107,6 +2013,7 @@ paths: required: true schema: type: string + example: 123-123-1234 responses: '200': description: 'successful operation' @@ -2122,8 +2029,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,42 +2058,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2204,8 +2106,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: '200': description: 'successful operation' @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,7 +2196,7 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2307,7 +2204,7 @@ paths: schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query @@ -2315,7 +2212,7 @@ paths: schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query @@ -2337,8 +2234,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + example: + $ref: '#/components/examples/FaxLineListResponse' '4XX': description: failed_operation content: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2418,8 +2310,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: '200': description: 'successful operation' @@ -2435,8 +2327,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2546,8 +2433,8 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' + example: + $ref: '#/components/examples/FaxListResponse' '4XX': description: failed_operation content: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2627,8 +2509,8 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' @@ -2647,8 +2529,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,42 +2560,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: title: 'Send Fax | API Documentation | Dropbox Fax for Developers' @@ -2732,8 +2609,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: '200': description: 'successful operation' @@ -2749,8 +2626,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' '4XX': description: failed_operation content: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,8 +2704,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: '200': description: 'successful operation' @@ -2849,8 +2721,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' '4XX': description: failed_operation content: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,8 +2802,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: '200': description: 'successful operation' @@ -2952,8 +2819,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' + example: + $ref: '#/components/examples/ReportCreateResponse' '4XX': description: failed_operation content: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,8 +2898,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' @@ -3056,8 +2918,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,8 +3003,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' @@ -3166,8 +3023,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,10 +3212,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' @@ -3387,8 +3234,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,8 +3317,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' @@ -3495,8 +3337,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,42 +3371,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' @@ -3595,10 +3432,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' @@ -3617,8 +3454,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditResponse' '4XX': description: failed_operation content: @@ -3627,21 +3464,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,42 +3491,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEdit.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEdit.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEdit.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEdit.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEdit.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEdit.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEdit.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEdit.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' @@ -3719,10 +3551,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' @@ -3741,8 +3573,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedResponse' '4XX': description: failed_operation content: @@ -3751,21 +3583,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3777,42 +3609,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbedded.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbedded.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbedded.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbedded.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbedded.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbedded.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbedded.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' @@ -3842,8 +3669,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' @@ -3862,8 +3689,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3872,21 +3699,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3898,42 +3725,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' @@ -3966,8 +3788,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' @@ -3986,8 +3808,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateResponse' '4XX': description: failed_operation content: @@ -3996,21 +3818,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4023,42 +3845,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditWithTemplate.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditWithTemplate.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditWithTemplate.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditWithTemplate.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditWithTemplate.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditWithTemplate.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditWithTemplate.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' @@ -4121,23 +3938,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4150,42 +3967,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -4224,8 +4036,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -4234,23 +4046,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4263,42 +4075,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -4344,8 +4151,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -4354,23 +4161,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4383,42 +4190,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -4454,8 +4256,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + example: + $ref: '#/components/examples/SignatureRequestGetResponse' '4XX': description: failed_operation content: @@ -4464,19 +4266,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4489,42 +4291,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' @@ -4582,8 +4379,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + example: + $ref: '#/components/examples/SignatureRequestListResponse' '4XX': description: failed_operation content: @@ -4592,17 +4389,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4615,42 +4412,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: title: 'List Signature Requests | REST API | Dropbox Sign for Developers' @@ -4686,8 +4478,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' '4XX': description: failed_operation content: @@ -4696,17 +4488,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4718,42 +4510,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' @@ -4784,8 +4571,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: '200': description: 'successful operation' @@ -4801,8 +4588,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' '4XX': description: failed_operation content: @@ -4811,23 +4598,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4840,42 +4627,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' @@ -4921,21 +4703,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4944,42 +4726,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: title: 'Remove Signature Request Access | Dropbox Sign for Developers' @@ -4998,10 +4775,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' @@ -5020,8 +4797,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendResponse' '4XX': description: failed_operation content: @@ -5030,19 +4807,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5055,42 +4832,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: title: 'Send Signature Request | REST API | Dropbox Sign for Developers' @@ -5109,8 +4881,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' @@ -5129,8 +4901,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -5139,17 +4911,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5162,42 +4934,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: title: 'Send with Template | API Documentation | Dropbox Sign for Developers' @@ -5230,8 +4997,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: '200': description: 'successful operation' @@ -5247,8 +5014,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' '4XX': description: failed_operation content: @@ -5257,17 +5024,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5279,42 +5046,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: title: 'Update Signature Request | REST API | Dropbox Sign for Developers' @@ -5342,10 +5104,10 @@ paths: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: '200': description: 'successful operation' @@ -5361,8 +5123,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + example: + $ref: '#/components/examples/TeamAddMemberResponse' '4XX': description: failed_operation content: @@ -5371,17 +5133,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5393,42 +5155,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' @@ -5447,8 +5204,8 @@ paths: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamCreateRequest' responses: '200': description: 'successful operation' @@ -5464,8 +5221,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + example: + $ref: '#/components/examples/TeamCreateResponse' '4XX': description: failed_operation content: @@ -5474,15 +5231,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5494,42 +5251,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' @@ -5559,15 +5311,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5579,42 +5331,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' @@ -5641,8 +5388,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' + example: + $ref: '#/components/examples/TeamGetResponse' '4XX': description: failed_operation content: @@ -5651,17 +5398,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5673,42 +5420,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/TeamGetExample.sh x-meta: seo: title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' @@ -5726,8 +5468,8 @@ paths: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: '200': description: 'successful operation' @@ -5743,8 +5485,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + example: + $ref: '#/components/examples/TeamUpdateResponse' '4XX': description: failed_operation content: @@ -5753,15 +5495,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5773,42 +5515,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: title: 'Update Team | API Documentation | Dropbox Sign for Developers' @@ -5844,8 +5581,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + example: + $ref: '#/components/examples/TeamGetInfoResponse' '4XX': description: failed_operation content: @@ -5854,19 +5591,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5878,42 +5615,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: title: 'Get Team Info | Dropbox Sign for Developers' @@ -5948,8 +5680,8 @@ paths: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' + example: + $ref: '#/components/examples/TeamInvitesResponse' '4XX': description: failed_operation content: @@ -5958,15 +5690,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5979,42 +5711,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: title: 'List Team Invites | Dropbox Sign for Developers' @@ -6066,8 +5793,8 @@ paths: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + example: + $ref: '#/components/examples/TeamMembersResponse' '4XX': description: failed_operation content: @@ -6076,19 +5803,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6100,42 +5827,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: title: 'List Team Members | Dropbox Sign for Developers' @@ -6154,10 +5876,10 @@ paths: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: '201': description: 'successful operation' @@ -6173,8 +5895,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' '4XX': description: failed_operation content: @@ -6183,17 +5905,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6205,42 +5927,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: title: 'Remove User from Team | REST API | Dropbox Sign for Developers' @@ -6292,8 +6009,8 @@ paths: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + example: + $ref: '#/components/examples/TeamSubTeamsResponse' '4XX': description: failed_operation content: @@ -6302,19 +6019,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6326,42 +6043,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: title: 'List Sub Teams | Dropbox Sign for Developers' @@ -6389,8 +6101,8 @@ paths: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: '200': description: 'successful operation' @@ -6406,8 +6118,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + example: + $ref: '#/components/examples/TemplateAddUserResponse' '4XX': description: failed_operation content: @@ -6416,17 +6128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6438,42 +6150,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: title: 'Add User to Template | REST API | Dropbox Sign for Developers' @@ -6492,14 +6199,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' @@ -6518,8 +6225,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + example: + $ref: '#/components/examples/TemplateCreateResponse' '4XX': description: failed_operation content: @@ -6528,19 +6235,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6552,42 +6259,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: title: 'Create Template | Dropbox Sign for Developers' @@ -6606,14 +6308,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' @@ -6632,8 +6334,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' '4XX': description: failed_operation content: @@ -6642,19 +6344,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6666,42 +6368,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: title: 'Create Embedded Template Draft | Dropbox Sign for Developers' @@ -6742,19 +6439,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6766,42 +6463,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: title: 'Delete Template | API Documentation | Dropbox Sign for Developers' @@ -6861,23 +6553,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6889,42 +6581,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6963,8 +6650,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -6973,23 +6660,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7001,42 +6688,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -7082,8 +6764,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -7092,23 +6774,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7120,42 +6802,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -7191,8 +6868,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + example: + $ref: '#/components/examples/TemplateGetResponse' '4XX': description: failed_operation content: @@ -7201,19 +6878,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7225,42 +6902,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: title: 'Get Template | API Documentation | Dropbox Sign for Developers' @@ -7319,8 +6991,8 @@ paths: schema: $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + example: + $ref: '#/components/examples/TemplateListResponse' '4XX': description: failed_operation content: @@ -7329,19 +7001,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7353,42 +7025,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateListExample.sh x-meta: seo: title: 'List Templates | API Documentation | Dropbox Sign for Developers' @@ -7416,8 +7083,8 @@ paths: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: '200': description: 'successful operation' @@ -7433,8 +7100,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' '4XX': description: failed_operation content: @@ -7443,17 +7110,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7465,42 +7132,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: title: 'Remove User from Template | REST API | Dropbox Sign for Developers' @@ -7540,8 +7202,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' @@ -7560,8 +7222,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' '4XX': description: failed_operation content: @@ -7570,21 +7232,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7596,42 +7258,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateUpdateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateUpdateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateUpdateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateUpdateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateUpdateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: title: 'Update Template Files | REST API | Dropbox Sign for Developers' @@ -7650,14 +7307,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' @@ -7676,8 +7333,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' '4XX': description: failed_operation content: @@ -7686,15 +7343,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7706,42 +7363,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/UnclaimedDraftCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' @@ -7763,14 +7415,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' @@ -7789,8 +7441,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -7799,19 +7451,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7824,42 +7476,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' @@ -7881,8 +7528,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' @@ -7901,8 +7548,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -7911,21 +7558,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7937,42 +7584,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' @@ -8003,8 +7645,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' responses: '200': description: 'successful operation' @@ -8020,8 +7662,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' '4XX': description: failed_operation content: @@ -8030,21 +7672,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -8057,42 +7699,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftEditAndResendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftEditAndResendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftEditAndResendExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftEditAndResendExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftEditAndResendExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftEditAndResendExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' @@ -14089,522 +13726,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditRequestDefaultExample.json - SignatureRequestEditRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json - SignatureRequestEditEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -14616,9 +14253,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -14629,11 +14266,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -14670,6 +14307,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -14697,37 +14335,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -14750,37 +14383,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/openapi.yaml b/openapi.yaml index 5643bcbfb..e8f8b5b24 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -27,10 +27,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: '200': description: 'successful operation' @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' '4XX': description: failed_operation content: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -161,8 +156,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' + example: + $ref: '#/components/examples/AccountGetResponse' '4XX': description: failed_operation content: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,8 +235,8 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: '200': description: 'successful operation' @@ -262,8 +252,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' + example: + $ref: '#/components/examples/AccountUpdateResponse' '4XX': description: failed_operation content: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,8 +333,8 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: '200': description: 'successful operation' @@ -365,10 +350,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' '4XX': description: failed_operation content: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,8 +431,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' @@ -471,8 +451,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' + example: + $ref: '#/components/examples/ApiAppCreateResponse' '4XX': description: failed_operation content: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -574,8 +549,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' + example: + $ref: '#/components/examples/ApiAppGetResponse' '4XX': description: failed_operation content: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,8 +640,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' @@ -690,8 +660,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' + example: + $ref: '#/components/examples/ApiAppUpdateResponse' '4XX': description: failed_operation content: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -896,8 +856,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' + example: + $ref: '#/components/examples/ApiAppListResponse' '4XX': description: failed_operation content: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -1011,8 +966,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' + example: + $ref: '#/components/examples/BulkSendJobGetResponse' '4XX': description: failed_operation content: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1119,8 +1069,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' + example: + $ref: '#/components/examples/BulkSendJobListResponse' '4XX': description: failed_operation content: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,8 +1158,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: '200': description: 'successful operation' @@ -1230,8 +1175,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' '4XX': description: failed_operation content: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1333,8 +1273,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' '4XX': description: failed_operation content: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1440,8 +1375,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,42 +1406,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,42 +1592,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' @@ -1721,8 +1641,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: '200': description: 'successful operation' @@ -1738,8 +1658,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1826,6 +1741,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -1925,8 +1841,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' '4XX': description: failed_operation content: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,42 +1868,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' @@ -2006,8 +1917,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: '200': description: 'successful operation' @@ -2023,8 +1934,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2107,6 +2013,7 @@ paths: required: true schema: type: string + example: 123-123-1234 responses: '200': description: 'successful operation' @@ -2122,8 +2029,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,42 +2058,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2204,8 +2106,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: '200': description: 'successful operation' @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,7 +2196,7 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2307,7 +2204,7 @@ paths: schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query @@ -2315,7 +2212,7 @@ paths: schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query @@ -2337,8 +2234,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + example: + $ref: '#/components/examples/FaxLineListResponse' '4XX': description: failed_operation content: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2418,8 +2310,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: '200': description: 'successful operation' @@ -2435,8 +2327,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2546,8 +2433,8 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' + example: + $ref: '#/components/examples/FaxListResponse' '4XX': description: failed_operation content: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2627,8 +2509,8 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' @@ -2647,8 +2529,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,42 +2560,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: title: 'Send Fax | API Documentation | Dropbox Fax for Developers' @@ -2732,8 +2609,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: '200': description: 'successful operation' @@ -2749,8 +2626,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' '4XX': description: failed_operation content: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,8 +2704,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: '200': description: 'successful operation' @@ -2849,8 +2721,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' '4XX': description: failed_operation content: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,8 +2802,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: '200': description: 'successful operation' @@ -2952,8 +2819,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' + example: + $ref: '#/components/examples/ReportCreateResponse' '4XX': description: failed_operation content: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,8 +2898,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' @@ -3056,8 +2918,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,8 +3003,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' @@ -3166,8 +3023,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,10 +3212,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' @@ -3387,8 +3234,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,8 +3317,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' @@ -3495,8 +3337,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,42 +3371,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' @@ -3625,23 +3462,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,42 +3491,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -3728,8 +3560,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -3738,23 +3570,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3767,42 +3599,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -3848,8 +3675,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -3858,23 +3685,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3887,42 +3714,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -3958,8 +3780,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + example: + $ref: '#/components/examples/SignatureRequestGetResponse' '4XX': description: failed_operation content: @@ -3968,19 +3790,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,42 +3815,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' @@ -4086,8 +3903,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + example: + $ref: '#/components/examples/SignatureRequestListResponse' '4XX': description: failed_operation content: @@ -4096,17 +3913,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4119,42 +3936,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: title: 'List Signature Requests | REST API | Dropbox Sign for Developers' @@ -4190,8 +4002,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' '4XX': description: failed_operation content: @@ -4200,17 +4012,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4222,42 +4034,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' @@ -4288,8 +4095,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: '200': description: 'successful operation' @@ -4305,8 +4112,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' '4XX': description: failed_operation content: @@ -4315,23 +4122,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,42 +4151,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' @@ -4425,21 +4227,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4448,42 +4250,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: title: 'Remove Signature Request Access | Dropbox Sign for Developers' @@ -4502,10 +4299,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' @@ -4524,8 +4321,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendResponse' '4XX': description: failed_operation content: @@ -4534,19 +4331,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4559,42 +4356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: title: 'Send Signature Request | REST API | Dropbox Sign for Developers' @@ -4613,8 +4405,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' @@ -4633,8 +4425,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -4643,17 +4435,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4666,42 +4458,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: title: 'Send with Template | API Documentation | Dropbox Sign for Developers' @@ -4734,8 +4521,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: '200': description: 'successful operation' @@ -4751,8 +4538,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' '4XX': description: failed_operation content: @@ -4761,17 +4548,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4783,42 +4570,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: title: 'Update Signature Request | REST API | Dropbox Sign for Developers' @@ -4846,10 +4628,10 @@ paths: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: '200': description: 'successful operation' @@ -4865,8 +4647,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + example: + $ref: '#/components/examples/TeamAddMemberResponse' '4XX': description: failed_operation content: @@ -4875,17 +4657,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4897,42 +4679,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' @@ -4951,8 +4728,8 @@ paths: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamCreateRequest' responses: '200': description: 'successful operation' @@ -4968,8 +4745,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + example: + $ref: '#/components/examples/TeamCreateResponse' '4XX': description: failed_operation content: @@ -4978,15 +4755,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4998,42 +4775,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' @@ -5063,15 +4835,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5083,42 +4855,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' @@ -5145,8 +4912,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' + example: + $ref: '#/components/examples/TeamGetResponse' '4XX': description: failed_operation content: @@ -5155,17 +4922,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5177,42 +4944,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/TeamGetExample.sh x-meta: seo: title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' @@ -5230,8 +4992,8 @@ paths: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: '200': description: 'successful operation' @@ -5247,8 +5009,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + example: + $ref: '#/components/examples/TeamUpdateResponse' '4XX': description: failed_operation content: @@ -5257,15 +5019,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5277,42 +5039,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: title: 'Update Team | API Documentation | Dropbox Sign for Developers' @@ -5348,8 +5105,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + example: + $ref: '#/components/examples/TeamGetInfoResponse' '4XX': description: failed_operation content: @@ -5358,19 +5115,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5382,42 +5139,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: title: 'Get Team Info | Dropbox Sign for Developers' @@ -5452,8 +5204,8 @@ paths: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' + example: + $ref: '#/components/examples/TeamInvitesResponse' '4XX': description: failed_operation content: @@ -5462,15 +5214,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5483,42 +5235,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: title: 'List Team Invites | Dropbox Sign for Developers' @@ -5570,8 +5317,8 @@ paths: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + example: + $ref: '#/components/examples/TeamMembersResponse' '4XX': description: failed_operation content: @@ -5580,19 +5327,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5604,42 +5351,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: title: 'List Team Members | Dropbox Sign for Developers' @@ -5658,10 +5400,10 @@ paths: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: '201': description: 'successful operation' @@ -5677,8 +5419,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' '4XX': description: failed_operation content: @@ -5687,17 +5429,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5709,42 +5451,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: title: 'Remove User from Team | REST API | Dropbox Sign for Developers' @@ -5796,8 +5533,8 @@ paths: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + example: + $ref: '#/components/examples/TeamSubTeamsResponse' '4XX': description: failed_operation content: @@ -5806,19 +5543,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5830,42 +5567,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: title: 'List Sub Teams | Dropbox Sign for Developers' @@ -5893,8 +5625,8 @@ paths: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: '200': description: 'successful operation' @@ -5910,8 +5642,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + example: + $ref: '#/components/examples/TemplateAddUserResponse' '4XX': description: failed_operation content: @@ -5920,17 +5652,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5942,42 +5674,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: title: 'Add User to Template | REST API | Dropbox Sign for Developers' @@ -5996,14 +5723,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' @@ -6022,8 +5749,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + example: + $ref: '#/components/examples/TemplateCreateResponse' '4XX': description: failed_operation content: @@ -6032,19 +5759,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6056,42 +5783,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: title: 'Create Template | Dropbox Sign for Developers' @@ -6110,14 +5832,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' @@ -6136,8 +5858,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' '4XX': description: failed_operation content: @@ -6146,19 +5868,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6170,42 +5892,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: title: 'Create Embedded Template Draft | Dropbox Sign for Developers' @@ -6246,19 +5963,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6270,42 +5987,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: title: 'Delete Template | API Documentation | Dropbox Sign for Developers' @@ -6365,23 +6077,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6393,42 +6105,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6467,8 +6174,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -6477,23 +6184,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6505,42 +6212,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6586,8 +6288,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -6596,23 +6298,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6624,42 +6326,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6695,8 +6392,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + example: + $ref: '#/components/examples/TemplateGetResponse' '4XX': description: failed_operation content: @@ -6705,19 +6402,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6729,42 +6426,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: title: 'Get Template | API Documentation | Dropbox Sign for Developers' @@ -6823,8 +6515,8 @@ paths: schema: $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + example: + $ref: '#/components/examples/TemplateListResponse' '4XX': description: failed_operation content: @@ -6833,19 +6525,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6857,42 +6549,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateListExample.sh x-meta: seo: title: 'List Templates | API Documentation | Dropbox Sign for Developers' @@ -6920,8 +6607,8 @@ paths: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: '200': description: 'successful operation' @@ -6937,8 +6624,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' '4XX': description: failed_operation content: @@ -6947,17 +6634,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6969,42 +6656,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: title: 'Remove User from Template | REST API | Dropbox Sign for Developers' @@ -7044,8 +6726,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' @@ -7064,8 +6746,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' '4XX': description: failed_operation content: @@ -7074,21 +6756,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7100,42 +6782,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateUpdateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateUpdateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateUpdateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateUpdateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateUpdateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: title: 'Update Template Files | REST API | Dropbox Sign for Developers' @@ -7154,14 +6831,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' @@ -7180,8 +6857,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' '4XX': description: failed_operation content: @@ -7190,15 +6867,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7210,42 +6887,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/UnclaimedDraftCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' @@ -7267,14 +6939,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' @@ -7293,8 +6965,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -7303,19 +6975,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7328,42 +7000,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' @@ -7385,8 +7052,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' @@ -7405,8 +7072,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -7415,21 +7082,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7441,42 +7108,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' @@ -7507,8 +7169,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' responses: '200': description: 'successful operation' @@ -7524,8 +7186,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' '4XX': description: failed_operation content: @@ -7534,21 +7196,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7561,42 +7223,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftEditAndResendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftEditAndResendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftEditAndResendExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftEditAndResendExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftEditAndResendExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftEditAndResendExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' @@ -13571,522 +13228,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditRequestDefaultExample.json - SignatureRequestEditRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json - SignatureRequestEditEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -14098,9 +13755,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -14111,11 +13768,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -14152,6 +13809,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -14228,37 +13886,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -14281,37 +13934,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/sandbox/.gitignore b/sandbox/.gitignore index 36ef23211..bae462a8a 100644 --- a/sandbox/.gitignore +++ b/sandbox/.gitignore @@ -1,45 +1 @@ -dotnet/* -!dotnet/.gitignore -!dotnet/hellosign_sandbox.csproj -!dotnet/NuGet.Config -!dotnet/Program.cs -!dotnet/src -!dotnet/test_fixtures - -java-v1/* -!java-v1/pom.xml -!java-v1/src -java-v1/src/main/java/com/dropbox/sign_sandbox/* -!java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java -!java-v1/test_fixtures - -java-v2/* -!java-v2/pom.xml -!java-v2/src -java-v2/src/main/java/com/dropbox/sign_sandbox/* -!java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java -!java-v2/test_fixtures - -node/* -!node/Example.ts -!node/package.json -!node/tests -!node/test_fixtures - -php/* -!php/composer.json -!php/Example.php -!php/test -!php/test_fixtures - -python/* -!python/Example.py -!python/requirements.txt -!python/tests -!python/test_fixtures - -ruby/* -!ruby/Example.rb -!ruby/Gemfile -!ruby/spec -!ruby/test_fixtures +**/artifacts/ diff --git a/sandbox/dotnet/Dropbox.SignSandbox.sln b/sandbox/dotnet/Dropbox.SignSandbox.sln new file mode 100644 index 000000000..359701322 --- /dev/null +++ b/sandbox/dotnet/Dropbox.SignSandbox.sln @@ -0,0 +1,21 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 2012 +VisualStudioVersion = 12.0.0.0 +MinimumVisualStudioVersion = 10.0.0.1 +Project("{7045D429-F203-4317-A29F-FB9FD34B7FF9}") = "Dropbox.SignSandbox", "src\Dropbox.SignSandbox\Dropbox.SignSandbox.csproj", "{F8C8232D-7020-4603-8E04-18D060AE530B}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {F8C8232D-7020-4603-8E04-18D060AE530B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F8C8232D-7020-4603-8E04-18D060AE530B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F8C8232D-7020-4603-8E04-18D060AE530B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F8C8232D-7020-4603-8E04-18D060AE530B}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj deleted file mode 100644 index 4f8b41f9d..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj +++ /dev/null @@ -1,24 +0,0 @@ - - - - Dropbox.SignSandbox.Test - Dropbox.SignSandbox.Test - net6.0 - false - Dropbox.SignSandbox.Test - - - - - - - - - - - - - - - - diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs deleted file mode 100644 index 2350a526b..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs +++ /dev/null @@ -1,168 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using System.Reflection; -using Xunit; -using Dropbox.Sign; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; - -namespace Dropbox.SignSandbox.Test -{ - public class TestHelper - { - public static JObject GetJsonContents(string fileName) - { - using (var r = new StreamReader( $"./../../../../../{fileName}")) - { - dynamic json = JsonConvert.DeserializeObject(r.ReadToEnd()); - Assert.NotNull(json); - - return json; - } - } - - public static JObject GetConfig() - { - dynamic configCustom = GetJsonContents("src/Dropbox.SignSandbox.Test/.config.json"); - dynamic configDist = GetJsonContents("src/Dropbox.SignSandbox.Test/.config.dist.json"); - - var mergeSettings = new JsonMergeSettings - { - MergeArrayHandling = MergeArrayHandling.Union - }; - - configDist.Merge(configCustom, mergeSettings); - - return configDist; - } - } - - public class SignatureRequestTests - { - [Fact] - public void SendTest() - { - dynamic config_merged = TestHelper.GetConfig(); - - var config = new Sign.Client.Configuration(); - config.Username = config_merged["API_KEY"]; - config.BasePath = config_merged["BASE_URL"]; - - var signatureRequestApi = new Sign.Api.SignatureRequestApi(config); - - var data = TestHelper.GetJsonContents("test_fixtures/SignatureRequestSendRequest.json"); - - var sendRequest = Sign.Model.SignatureRequestSendRequest.Init(data.ToString()); - - sendRequest.Files = new List { - new FileStream( - "./../../../../../test_fixtures/pdf-sample.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var sendResponse = signatureRequestApi.SignatureRequestSend(sendRequest); - - Assert.Equal( - sendRequest.FormFieldsPerDocument[0].ApiId, - sendResponse.SignatureRequest.CustomFields[0].ApiId - ); - - Assert.Equal( - sendRequest.Signers[0].EmailAddress, - sendResponse.SignatureRequest.Signatures[0].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[1].EmailAddress, - sendResponse.SignatureRequest.Signatures[1].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[2].EmailAddress, - sendResponse.SignatureRequest.Signatures[2].SignerEmailAddress - ); - - var getResponse = signatureRequestApi.SignatureRequestGet(sendResponse.SignatureRequest.SignatureRequestId); - - Assert.Equal( - sendResponse.SignatureRequest.SignatureRequestId, - getResponse.SignatureRequest.SignatureRequestId - ); - } - - [Fact] - public void CreateEmbeddedTest() - { - dynamic config_merged = TestHelper.GetConfig(); - - var config = new Sign.Client.Configuration(); - config.Username = config_merged["API_KEY"]; - config.BasePath = config_merged["BASE_URL"]; - - var signatureRequestApi = new Sign.Api.SignatureRequestApi(config); - - var data = TestHelper.GetJsonContents("test_fixtures/SignatureRequestSendRequest.json"); - data["client_id"] = config_merged["CLIENT_ID"]; - - var sendRequest = Sign.Model.SignatureRequestCreateEmbeddedRequest.Init(data.ToString()); - - sendRequest.Files = new List { - new FileStream( - "./../../../../../test_fixtures/pdf-sample.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var sendResponse = signatureRequestApi.SignatureRequestCreateEmbedded(sendRequest); - - Assert.Equal( - sendRequest.Signers[0].EmailAddress, - sendResponse.SignatureRequest.Signatures[0].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[1].EmailAddress, - sendResponse.SignatureRequest.Signatures[1].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[2].EmailAddress, - sendResponse.SignatureRequest.Signatures[2].SignerEmailAddress - ); - - var embeddedApi = new Sign.Api.EmbeddedApi(config); - - var getResponse = embeddedApi.EmbeddedSignUrl(sendResponse.SignatureRequest.Signatures[0].SignatureId); - - Assert.NotEmpty(getResponse.Embedded.SignUrl); - } - - [Fact] - public void SendWithoutFillErrorTest() - { - dynamic config_merged = TestHelper.GetConfig(); - - var config = new Sign.Client.Configuration(); - config.Username = config_merged["API_KEY"]; - config.BasePath = config_merged["BASE_URL"]; - - var signatureRequestApi = new Sign.Api.SignatureRequestApi(config); - - var data = TestHelper.GetJsonContents("test_fixtures/SignatureRequestSendRequest.json"); - - var sendRequest = Sign.Model.SignatureRequestSendRequest.Init(data.ToString()); - - try - { - signatureRequestApi.SignatureRequestSend(sendRequest); - Assert.True(false); - } - catch (Sign.Client.ApiException e) - { - Assert.Equal("file", e.ErrorContent.Error.ErrorPath); - } - } - } -} \ No newline at end of file diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs new file mode 100644 index 000000000..373d6a20f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs new file mode 100644 index 000000000..1976cb18e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateOauthExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com", + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs new file mode 100644 index 000000000..83d94716e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new AccountApi(config).AccountGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs new file mode 100644 index 000000000..f62bb1125 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountUpdateRequest = new AccountUpdateRequest( + callbackUrl: "https://www.example.com/callback", + locale: "en-US" + ); + + try + { + var response = new AccountApi(config).AccountUpdate( + accountUpdateRequest: accountUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs new file mode 100644 index 000000000..cba51330d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountVerifyExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountVerifyRequest = new AccountVerifyRequest( + emailAddress: "some_user@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountVerify( + accountVerifyRequest: accountVerifyRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountVerify: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs new file mode 100644 index 000000000..277e40121 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs @@ -0,0 +1,61 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppCreateRequest = new ApiAppCreateRequest( + name: "My Production App", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppCreate( + apiAppCreateRequest: apiAppCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs new file mode 100644 index 000000000..87235a6a3 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new ApiAppApi(config).ApiAppDelete( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs new file mode 100644 index 000000000..8bbf80af4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppGet( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs new file mode 100644 index 000000000..be9060253 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs new file mode 100644 index 000000000..3eb03a1bf --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs @@ -0,0 +1,63 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppUpdateRequest = new ApiAppUpdateRequest( + callbackUrl: "https://example.com/dropboxsign", + name: "New Name", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppUpdate( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9", + apiAppUpdateRequest: apiAppUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs new file mode 100644 index 000000000..baa383c93 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobGet( + bulkSendJobId: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs new file mode 100644 index 000000000..d84e42e04 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj index 1adb5f2bf..decd15400 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj @@ -1,8 +1,8 @@ - false - net6.0 + false + net9.0 Dropbox.SignSandbox Dropbox.SignSandbox Library @@ -10,9 +10,10 @@ false annotations false + latestmajor - + diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs new file mode 100644 index 000000000..f951e1751 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs @@ -0,0 +1,45 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedEditUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var mergeFields = new List(); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest( + ccRoles: [ + "", + ], + mergeFields: mergeFields + ); + + try + { + var response = new EmbeddedApi(config).EmbeddedEditUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + embeddedEditUrlRequest: embeddedEditUrlRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedEditUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs new file mode 100644 index 000000000..a800f0b04 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedSignUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new EmbeddedApi(config).EmbeddedSignUrl( + signatureId: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedSignUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs new file mode 100644 index 000000000..b642a7ff1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs @@ -0,0 +1,8 @@ +namespace Dropbox.SignSandbox; + +public class Entry +{ + public static void Main() + { + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs new file mode 100644 index 000000000..c8610a8fe --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs @@ -0,0 +1,44 @@ +using System.Collections.Generic; +using Newtonsoft.Json; +using Dropbox.Sign.Model; +using Dropbox.Sign; + +namespace Dropbox.SignSandbox; + +public class EventCallbackExample +{ + public static void Run() + { + // use your API key + var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; + + // callbackData represents data we send to you + var callbackData = new Dictionary() + { + ["event"] = new Dictionary() + { + ["event_type"] = "account_confirmed", + ["event_time"] = "1669926463", + ["event_hash"] = "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + ["event_metadata"] = new Dictionary() + { + ["related_signature_id"] = null, + ["reported_for_account_id"] = "6421d70b9bd45059fa207d03ab8d1b96515b472c", + ["reported_for_app_id"] = null, + ["event_message"] = null, + } + } + }; + + var callbackEvent = EventCallbackRequest.Init(JsonConvert.SerializeObject(callbackData)); + + // verify that a callback came from HelloSign.com + if (EventCallbackHelper.IsValid(apiKey, callbackEvent)) + { + // one of "account_callback" or "api_app_callback" + var callbackType = EventCallbackHelper.GetCallbackType(callbackEvent); + + // do your magic below! + } + } +} diff --git a/examples/FaxLineGet.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs similarity index 57% rename from examples/FaxLineGet.cs rename to sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs index d18c82fab..aa39f496d 100644 --- a/examples/FaxLineGet.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs @@ -1,27 +1,30 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - try { - var result = faxLineApi.FaxLineGet("[FAX_NUMBER]"); - Console.WriteLine(result); + new FaxApi(config).FaxDelete( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs new file mode 100644 index 000000000..278b90f8b --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxFiles( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs new file mode 100644 index 000000000..8a15843d1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxGet( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineRemoveUser.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs similarity index 53% rename from examples/FaxLineRemoveUser.cs rename to sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs index 1dd562ed6..cb9c642f7 100644 --- a/examples/FaxLineRemoveUser.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs @@ -1,32 +1,37 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineAddUserExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineRemoveUserRequest( + var faxLineAddUserRequest = new FaxLineAddUserRequest( number: "[FAX_NUMBER]", emailAddress: "member@dropboxsign.com" ); try { - var result = faxLineApi.FaxLineRemoveUser(data); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineAddUser( + faxLineAddUserRequest: faxLineAddUserRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAddUser: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs new file mode 100644 index 000000000..b2b60876b --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineAreaCodeGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAreaCodeGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs new file mode 100644 index 000000000..802ea4045 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineCreateRequest = new FaxLineCreateRequest( + areaCode: 209, + country: FaxLineCreateRequest.CountryEnum.US + ); + + try + { + var response = new FaxLineApi(config).FaxLineCreate( + faxLineCreateRequest: faxLineCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs new file mode 100644 index 000000000..42faed216 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineDeleteRequest = new FaxLineDeleteRequest( + number: "[FAX_NUMBER]" + ); + + try + { + new FaxLineApi(config).FaxLineDelete( + faxLineDeleteRequest: faxLineDeleteRequest + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs new file mode 100644 index 000000000..690a65360 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineGet( + number: "123-123-1234" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs new file mode 100644 index 000000000..cbd75903e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineList( + accountId: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + pageSize: 20, + showTeamLines: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs new file mode 100644 index 000000000..809b89a4e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest( + number: "[FAX_NUMBER]", + emailAddress: "member@dropboxsign.com" + ); + + try + { + var response = new FaxLineApi(config).FaxLineRemoveUser( + faxLineRemoveUserRequest: faxLineRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs new file mode 100644 index 000000000..64450619d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs new file mode 100644 index 000000000..e6a2270be --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs @@ -0,0 +1,51 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxSendRequest = new FaxSendRequest( + recipient: "16690000001", + sender: "16690000000", + testMode: true, + coverPageTo: "Jill Fax", + coverPageFrom: "Faxer Faxerson", + coverPageMessage: "I'm sending you a fax!", + title: "This is what the fax is about!", + files: new List + { + new FileStream( + path: "./example_fax.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new FaxApi(config).FaxSend( + faxSendRequest: faxSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs new file mode 100644 index 000000000..7d8da2fca --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenGenerateExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest( + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465", + code: "1b0d28d90c86c141", + state: "900e06e2", + grantType: "authorization_code" + ); + + try + { + var response = new OAuthApi(config).OauthTokenGenerate( + oAuthTokenGenerateRequest: oAuthTokenGenerateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenGenerate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs new file mode 100644 index 000000000..21c40d14c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenRefreshExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest( + grantType: "refresh_token", + refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + ); + + try + { + var response = new OAuthApi(config).OauthTokenRefresh( + oAuthTokenRefreshRequest: oAuthTokenRefreshRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenRefresh: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs deleted file mode 100644 index ad6fb38e6..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -namespace Dropbox.SignSandbox -{ - public class Example - { - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiInstance = new AccountApi(config); - - var data = new AccountCreateRequest( - emailAddress: "newuser@dropboxsign.com" - ); - - try - { - var result = apiInstance.AccountCreate(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); - } - } - } -} \ No newline at end of file diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs new file mode 100644 index 000000000..769bd3a18 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs @@ -0,0 +1,43 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ReportCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var reportCreateRequest = new ReportCreateRequest( + startDate: "09/01/2020", + endDate: "09/01/2020", + reportType: [ + ReportCreateRequest.ReportTypeEnum.UserActivity, + ReportCreateRequest.ReportTypeEnum.DocumentStatus, + ] + ); + + try + { + var response = new ReportApi(config).ReportCreate( + reportCreateRequest: reportCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ReportApi#ReportCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..9fd344a94 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + clientId: "1a659d9ad95bccd307ecad78d72192f8", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest: signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs new file mode 100644 index 000000000..3c95fdb32 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest( + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest: signatureRequestBulkSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs new file mode 100644 index 000000000..4d18209eb --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCancelExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new SignatureRequestApi(config).SignatureRequestCancel( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCancel: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs new file mode 100644 index 000000000..7f9786caf --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs @@ -0,0 +1,82 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..40cbcbc51 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs @@ -0,0 +1,110 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..d40f34240 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,66 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs new file mode 100644 index 000000000..356603bf6 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs @@ -0,0 +1,83 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..3be9c8142 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs @@ -0,0 +1,111 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..fff755e13 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbeddedWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedWithTemplateRequest: signatureRequestEditEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs new file mode 100644 index 000000000..b3542b75f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs @@ -0,0 +1,93 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs new file mode 100644 index 000000000..35a41afa4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs @@ -0,0 +1,121 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs new file mode 100644 index 000000000..172f24b6c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs @@ -0,0 +1,90 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditWithTemplateRequest: signatureRequestEditWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs new file mode 100644 index 000000000..60f837089 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsDataUri( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs new file mode 100644 index 000000000..f3bfe667a --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsFileUrl( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs new file mode 100644 index 000000000..879127eda --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFiles( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + fileType: "pdf" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs new file mode 100644 index 000000000..388861f1f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestGet( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs new file mode 100644 index 000000000..d5b2bfb9d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs new file mode 100644 index 000000000..9b64cd74c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestReleaseHoldExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestReleaseHold( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestReleaseHold: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs new file mode 100644 index 000000000..bef1acbf1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemindExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest( + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestRemind( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestRemindRequest: signatureRequestRemindRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemind: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs new file mode 100644 index 000000000..f0b9cf86e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemoveExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + new SignatureRequestApi(config).SignatureRequestRemove( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemove: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs new file mode 100644 index 000000000..2958c264c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs new file mode 100644 index 000000000..8263d9170 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs @@ -0,0 +1,120 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs new file mode 100644 index 000000000..024b92ce8 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs @@ -0,0 +1,89 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest: signatureRequestSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs new file mode 100644 index 000000000..7d9551620 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest( + signatureId: "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestUpdate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestUpdateRequest: signatureRequestUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs new file mode 100644 index 000000000..fe700fca7 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs new file mode 100644 index 000000000..3529c6ee0 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + emailAddress: "george@example.com" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs new file mode 100644 index 000000000..794c4627d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamCreateRequest = new TeamCreateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamCreate( + teamCreateRequest: teamCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineList.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs similarity index 58% rename from examples/FaxLineList.cs rename to sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs index 96d7f0c28..b5c7a83b4 100644 --- a/examples/FaxLineList.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs @@ -1,27 +1,29 @@ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = faxLineApi.FaxLineList(); - Console.WriteLine(result); + new TeamApi(config).TeamDelete(); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs new file mode 100644 index 000000000..3a79cd2a4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs new file mode 100644 index 000000000..a761bce3c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInfoExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInfo( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInfo: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs new file mode 100644 index 000000000..90454cbac --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInvitesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInvites(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInvites: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs new file mode 100644 index 000000000..72213f8a7 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamMembersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamMembers( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamMembers: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs new file mode 100644 index 000000000..0c6ae21a3 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs new file mode 100644 index 000000000..23aeff1ff --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + emailAddress: "teammate@dropboxsign.com", + newOwnerEmailAddress: "new_teammate@dropboxsign.com" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs new file mode 100644 index 000000000..1760310a5 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamSubTeamsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamSubTeams( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamSubTeams: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs new file mode 100644 index 000000000..355811ee4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamUpdateRequest = new TeamUpdateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamUpdate( + teamUpdateRequest: teamUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs new file mode 100644 index 000000000..dc4107a2f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateAddUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateAddUserRequest = new TemplateAddUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateAddUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateAddUserRequest: templateAddUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateAddUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs new file mode 100644 index 000000000..e26574c52 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs new file mode 100644 index 000000000..2603e2c47 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs new file mode 100644 index 000000000..6d7a8e39b --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..cb3fd770d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs new file mode 100644 index 000000000..09fad4bd6 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs @@ -0,0 +1,129 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b8c56e791 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldGroups: formFieldGroups, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..6e2224ff4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldRules: formFieldRules, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..503e80645 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs new file mode 100644 index 000000000..5a49ea03f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new TemplateApi(config).TemplateDelete( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs new file mode 100644 index 000000000..5c946b84a --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsDataUri( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs new file mode 100644 index 000000000..3b5bc98f1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsFileUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs new file mode 100644 index 000000000..96e9237ee --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + fileType: null + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs new file mode 100644 index 000000000..067300032 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateGet( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs new file mode 100644 index 000000000..b41f357ce --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs new file mode 100644 index 000000000..66bcbfe53 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateRemoveUserRequest = new TemplateRemoveUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateRemoveUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateRemoveUserRequest: templateRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs new file mode 100644 index 000000000..1fe2ccf5e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs @@ -0,0 +1,46 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateUpdateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest( + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new TemplateApi(config).TemplateUpdateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateUpdateFilesRequest: templateUpdateFilesRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateUpdateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs new file mode 100644 index 000000000..4637922b5 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs @@ -0,0 +1,48 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs new file mode 100644 index 000000000..58e77d162 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs @@ -0,0 +1,95 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs new file mode 100644 index 000000000..367136511 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs @@ -0,0 +1,115 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..f9b29f003 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs @@ -0,0 +1,81 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..2fea6ff83 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@dropboxsign.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signers1 = new SubUnclaimedDraftTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + testMode: false, + ccs: ccs, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest: unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs new file mode 100644 index 000000000..e5080a671 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs @@ -0,0 +1,59 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signers1 = new SubUnclaimedDraftSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b5ae35929 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs @@ -0,0 +1,94 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..dabc20ce6 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs @@ -0,0 +1,114 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..86eae8aea --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,80 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs new file mode 100644 index 000000000..459364b01 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftEditAndResendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + testMode: false + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftEditAndResend( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimedDraftEditAndResendRequest: unclaimedDraftEditAndResendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftEditAndResend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json b/sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/dotnet/test_fixtures/pdf-sample.pdf b/sandbox/dotnet/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d41575b222e6778f87f9e9fd8da4f2b1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7945 zcmeHMdpuO@*C+SMluP1J*&zvI@43%7V>Ap=#w8@A%w=P0%rG+|l|mN^ailm(Zs}e^ zN|F@npmOP+65Wq3lG43*4?-Qk^S<})*&y`N{@p6^=E+Rxf+hC9;{gSEn= zXLQ}a+=fPx0SFLrmZE7i(1kCA*^i3}2x43QZQ_BaS{X9wZ1_EbCr zqSG8n_Eel5o1%3!bAVS5^%S&?&k<5B6^tut*VOM^A~#N5&ZSVf z2aQ7D8xk-Cq(sUVOQXba5E=!cQ8Q*ZxH+Ox-@rwqaHD)S7ES<(I=mPP=n3E{-&q(K z7|0F`{B&7Pv7My8cWs)yNn^`e%ldJ3>gs6qcJ=nQX;Ra*lqPj`zi}FvBuhDYWx47u zrC-LdQwGdX?66=do5z;20qg)+?(AS#0uTqT2LQ82<^-bPkzk>Y@Y;)nQdlUJ0N6oh zd$B0YP88)2AtXd95ugxo0U!$r5B6V1kvKv)hZN0+C87v17g3BQ3}~J&k|N;)K!ZM$ z*)*abE0aEC{1_lQ^2HJh$A^`@cbFbvkoQ z+h-cB%`nYTRh^jdI9@ez>n2r4uL}wHOeW=;ss{UMb;cfg#B?g=OxL_;mRhW=Q*Tmn zB6qvD$JG|oY=cDv6v%xLL&)zae`{TmRTtl#aR1Gnnlf|DGnP`loIfE&Nx7LdQg7Om7{`#=?4z1;0f%4eLVHE53%MHtXmvZ_xX+Dk%nvCmYVkRwh4XiMSY~wh|{ba z?qVr@(v+zaf0<~bk<)sjbrECnjnvofxvH6VQv(>ojKT!$|c?M%+5GMRQo zz?$rrrb`Z6vilmO9~Ek-J15^Pk*_aXknVhprA%)QzQ;F-RcQ*uIo)on6ofuGajBF8 z?b}or>LL;>ck|R1bb>Ks@+^a3pm?%U(;9wKHKlS&T($c^JV;A^VOF+nqRH{oM*WE z)3uXerMB+w^cNFARe#Lo*RAw3j0+tKHzMU4r=4k-vo=e4?NLvtXrEz}(L-|7wXU#rvj%T0Dy>+XlXu5oroS`>cr>*2iZPG-w=oD<`__WSWutgFXy?N8CF%rbU zhW^i+Y$)SmiFjyaFF7Ta`OFjDCuuky`JyB7-=CmUWq4kCd{%QC$0B#5aAHZVi8-%D z<7wf0&(Fy_Rro7+Vo;WTitg|9#gDSHMD@1P?AwPMf%Pxg>663f&yHJzYiOk%K2R8U z@?dz*gXZVt<1a(i;vaI=Zm=aE+rU}0TNg=*=_Utq4M>Fj`cD>B z;pO`Ip>yrqL%RIXEhNunWrw;@ktURnvLLlJ3c{&eQWj0f_&99 zXXA0&^6S2YW$wv~O!v*5b8dp<<%PtsvV)FAeX5tv6fae4nbu*xwGFDEytCXad0Ddc zY|o_dq%1{uiyN-f&N~DdFY)W$z5Dk%iI&|&t^ANFPi`6-yvy{zh(oW_wa@6(s_UWn z9(S!Q$mDp~LVAVqHv`(>6t zIzhP@8=&n7rmr+&sVulW4}E4Idsj40&U1V`-KVWruLX|lcwQB3C||-h@wJ%mv|2Y} zjr#|mFYb%HGQUJA%V+GY*NzYKaoX8xu;AE?4$1LTzdLl~rY~8NLx}cVXLBG|b8#ly zxhiZY$_&aq-^4I3c5-VeubFLpBxn;lsZ(fbenGq5Ijf-dUB2413Da{_#^s&S?wb7x zD*Bwn*%0Tt{(bR>_0z)7nFO9HKWI^LRJFc{Ue;E)kJ;(=`?2o#zdHWrN?45j6{RC7 zT-~a0gjKsT+1f?S>%8x3q?4YY$aC?Kp00hZj@DGzqU?t50QS5USA=x&I5ixvhK2_! zdSSZe;JWbLcO5e0yfy46Ug+JO)3aN7^70S8`NoDNi*0a$n~x=*cyi!r&jw@1(o^RG z9eO(V>Ao;EOH{bmWSFCG_Qn!--qu4|ZAV*qe%Ub}=d~ZUc4Vs5UGJT3$2Hi%)6$&J zN?Mt`Xm1%kuUN?pv@*Y}n<4hFt?oOrXiD0yqdO$()~IQ+s($cwr_}4sU4fUs%uGozwqxAZEr48 z3{8=e!?F7{Z{>W|&N5O5FKn3A`AQ$Yg3^dKi&sp!`nd7XvR&@oJ=-2W2)9Z;_Mz19 zZr6^0&M5?u{YIuvyz|C_ZGtBijPU5fR*UDG1sZqRE2jo`SiXV^Hm6=6IJ zwL>md1&|(!@ILG8X_qSV!fCzFZ>f-VKOGb;FD3-@6I2eqnb4i#uAkNm8!%@CDBe^S ztl8_Uc2PZe=GDTv&W9E!#ot_LSu}?=Ys$&kQjBG6xzp`O=#xutw?5lpPEXo}MQ3W@ z-;#o+*1stW^b5=9EnPGFv>mCP_4+|V!qu;TsNXLAebQ-0M{x6@DeRTaH5Utwtw*k5A(G2Nn(Ju3}1kE88w&|7Ev)!s2>{+^2kHA_}}F01DE z(bKbens@rWb=M_y?p<9Nrj)XT8Q=)4517V1LijYVP&HtjZU}rw>AB`pk0{N@k^_17 zd_KIWjkR5#U9BQ_NN?jE)L0J?+~1zkh8`d|Xw(VUDbXvnYQkAaeO*6&{TvPZTbI0b z7h3liqn`1*7NjL;S3GS#K692*t;W2!58HNP-d@a`u04CvjeV09`Zf^mKQUdPI(5Q^ zTr-A&&Nbn_hPe}s&OWCpm!aQG*l(_V-7FOL9a_7tG1@Pi+ z5t9?QY`a(X$8~>J6ZTrki{H#(XkEwVsK@DW^v!u|<>l-z@NLILWdxKV1n{z|%rk-` z9Vkv%E`!I^Z-?@chbzrCDvZrt21@}B9LyKm7`?2lHUjuO8zUbg3u1-Y!y$a9Xff;= z?drviUdE;JjBM#BT9kEEXjmw6#0R261wx5+l#LM^DfwV) z$zj40u9zPt<%@)XOfH)vijdkE84cG|GTnnK<8g=eghhx216p`o5Ej6pvJwTvT4BLq z;WGI=u62+|9Lko`*B^93ttplkui?TAPj&A{mQ+ynams!C>nlrI&)KS+>?WeB9-kB+F9!DB68 z3xjQpqA)x-h#eu28qvK%_!0p5vH>ZKluO8~1t5qofd9_O?{y3q`JFj~yrVq!&7uJu zMveb(oM&6^kUIASvJ@67v9x)oAV^njhF%A|5|z#gGYD zJO&G4a1<|Oi{J>>$Sp(|HenRyk1~cz@&A*Q(X>Ny{xuIEn_z4YAQOlO@ZWm?8MJm6 zi+B-SSWIUi$Z^jN@Ub92^Bh<`URE9wmqh6NcrE z;{98k1|5$iT_od!!zusU{u{_r|Fyr71^?Gn0KiWr{|MZlaQ%eqA0hCMh<`@cPq_XO z0{@8kXLS8*aG^$uMx;MwV-$&$gkzNIe_yE&_EU!2DFn)3J5g4y{4ukG4c! z0xw#4Kv()Nxy(u_SKOpj_vc2h$%TKam=x`qeEX)nqMqEf$nk5(uw_)g@jv!fJ1wJ+)9ZbM}_28qbMpe)cZIYsE~p(O+` zS|{G<>dlI}T5gCm=YoTO<&A-XtOYjo>V52 - - 4.0.0 - - com.dropbox.sign_sandbox - DropboxSignSandbox - 1.0-SNAPSHOT - - - 9 - 9 - UTF-8 - - - - - com.dropbox.sign - dropbox-sign - ^1.0.0-beta - system - ${pom.basedir}/artifacts/dropbox-sign.jar - - - junit - junit - 4.13.1 - test - - - junit - junit - 4.13.1 - test - - - - diff --git a/sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java b/sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java deleted file mode 100644 index 1579ee556..000000000 --- a/sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiClient; -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Main { - public static void main(String[] args) { - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - ApiClient apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - AccountApi api = new AccountApi(apiClient); - - AccountCreateRequest data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = api.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling Dropbox Sign API"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json b/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore b/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java b/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java deleted file mode 100644 index d0df6afe9..000000000 --- a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java +++ /dev/null @@ -1,148 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiClient; -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.JSON; -import com.dropbox.sign.api.EmbeddedApi; -import com.dropbox.sign.api.SignatureRequestApi; -import com.dropbox.sign.model.*; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.ObjectReader; -import org.junit.Assert; -import org.junit.Test; - -import java.io.File; -import java.nio.file.Files; -import java.nio.file.Paths; - -public class SignatureRequestTest { - public static JsonNode getConfig() throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - - JsonNode configCustom = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.json") - )); - JsonNode configDist = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.dist.json") - )); - - ObjectReader updater = objectMapper.readerForUpdating(configDist); - - return updater.readValue(configCustom); - } - - public static JsonNode getJsonContents(String filename) throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - return objectMapper.readTree(Files.newInputStream( - Paths.get("test_fixtures/" + filename) - )); - } - - @Test - public void testSend() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestSend(sendRequest); - - Assert.assertEquals( - sendRequest.getFormFieldsPerDocument().get(0).getApiId(), - sendResponse.getSignatureRequest().getCustomFields().get(0).getApiId() - ); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - SignatureRequestGetResponse getResponse = signatureRequestApi.signatureRequestGet( - sendResponse.getSignatureRequest().getSignatureRequestId() - ); - - Assert.assertEquals( - sendResponse.getSignatureRequest().getSignatureRequestId(), - getResponse.getSignatureRequest().getSignatureRequestId() - ); - } - - @Test - public void testCreateEmbedded() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestCreateEmbeddedRequest.json"); - - SignatureRequestCreateEmbeddedRequest sendRequest = SignatureRequestCreateEmbeddedRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - sendRequest.clientId(config.findPath("CLIENT_ID").textValue()); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestCreateEmbedded(sendRequest); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - EmbeddedApi embeddedApi = new EmbeddedApi(apiClient); - - EmbeddedSignUrlResponse getResponse = embeddedApi.embeddedSignUrl( - sendResponse.getSignatureRequest().getSignatures().get(0).getSignatureId() - ); - - Assert.assertNotNull(getResponse.getEmbedded().getSignUrl()); - } - - @Test - public void testSendWithoutFileError() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - - try { - signatureRequestApi.signatureRequestSend(sendRequest); - Assert.fail(); - } catch (ApiException e) { - Assert.assertEquals("file", e.getErrorResponse().getError().getErrorPath()); - } - } -} diff --git a/sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json b/sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v1/test_fixtures/pdf-sample.pdf b/sandbox/java-v1/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d41575b222e6778f87f9e9fd8da4f2b1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7945 zcmeHMdpuO@*C+SMluP1J*&zvI@43%7V>Ap=#w8@A%w=P0%rG+|l|mN^ailm(Zs}e^ zN|F@npmOP+65Wq3lG43*4?-Qk^S<})*&y`N{@p6^=E+Rxf+hC9;{gSEn= zXLQ}a+=fPx0SFLrmZE7i(1kCA*^i3}2x43QZQ_BaS{X9wZ1_EbCr zqSG8n_Eel5o1%3!bAVS5^%S&?&k<5B6^tut*VOM^A~#N5&ZSVf z2aQ7D8xk-Cq(sUVOQXba5E=!cQ8Q*ZxH+Ox-@rwqaHD)S7ES<(I=mPP=n3E{-&q(K z7|0F`{B&7Pv7My8cWs)yNn^`e%ldJ3>gs6qcJ=nQX;Ra*lqPj`zi}FvBuhDYWx47u zrC-LdQwGdX?66=do5z;20qg)+?(AS#0uTqT2LQ82<^-bPkzk>Y@Y;)nQdlUJ0N6oh zd$B0YP88)2AtXd95ugxo0U!$r5B6V1kvKv)hZN0+C87v17g3BQ3}~J&k|N;)K!ZM$ z*)*abE0aEC{1_lQ^2HJh$A^`@cbFbvkoQ z+h-cB%`nYTRh^jdI9@ez>n2r4uL}wHOeW=;ss{UMb;cfg#B?g=OxL_;mRhW=Q*Tmn zB6qvD$JG|oY=cDv6v%xLL&)zae`{TmRTtl#aR1Gnnlf|DGnP`loIfE&Nx7LdQg7Om7{`#=?4z1;0f%4eLVHE53%MHtXmvZ_xX+Dk%nvCmYVkRwh4XiMSY~wh|{ba z?qVr@(v+zaf0<~bk<)sjbrECnjnvofxvH6VQv(>ojKT!$|c?M%+5GMRQo zz?$rrrb`Z6vilmO9~Ek-J15^Pk*_aXknVhprA%)QzQ;F-RcQ*uIo)on6ofuGajBF8 z?b}or>LL;>ck|R1bb>Ks@+^a3pm?%U(;9wKHKlS&T($c^JV;A^VOF+nqRH{oM*WE z)3uXerMB+w^cNFARe#Lo*RAw3j0+tKHzMU4r=4k-vo=e4?NLvtXrEz}(L-|7wXU#rvj%T0Dy>+XlXu5oroS`>cr>*2iZPG-w=oD<`__WSWutgFXy?N8CF%rbU zhW^i+Y$)SmiFjyaFF7Ta`OFjDCuuky`JyB7-=CmUWq4kCd{%QC$0B#5aAHZVi8-%D z<7wf0&(Fy_Rro7+Vo;WTitg|9#gDSHMD@1P?AwPMf%Pxg>663f&yHJzYiOk%K2R8U z@?dz*gXZVt<1a(i;vaI=Zm=aE+rU}0TNg=*=_Utq4M>Fj`cD>B z;pO`Ip>yrqL%RIXEhNunWrw;@ktURnvLLlJ3c{&eQWj0f_&99 zXXA0&^6S2YW$wv~O!v*5b8dp<<%PtsvV)FAeX5tv6fae4nbu*xwGFDEytCXad0Ddc zY|o_dq%1{uiyN-f&N~DdFY)W$z5Dk%iI&|&t^ANFPi`6-yvy{zh(oW_wa@6(s_UWn z9(S!Q$mDp~LVAVqHv`(>6t zIzhP@8=&n7rmr+&sVulW4}E4Idsj40&U1V`-KVWruLX|lcwQB3C||-h@wJ%mv|2Y} zjr#|mFYb%HGQUJA%V+GY*NzYKaoX8xu;AE?4$1LTzdLl~rY~8NLx}cVXLBG|b8#ly zxhiZY$_&aq-^4I3c5-VeubFLpBxn;lsZ(fbenGq5Ijf-dUB2413Da{_#^s&S?wb7x zD*Bwn*%0Tt{(bR>_0z)7nFO9HKWI^LRJFc{Ue;E)kJ;(=`?2o#zdHWrN?45j6{RC7 zT-~a0gjKsT+1f?S>%8x3q?4YY$aC?Kp00hZj@DGzqU?t50QS5USA=x&I5ixvhK2_! zdSSZe;JWbLcO5e0yfy46Ug+JO)3aN7^70S8`NoDNi*0a$n~x=*cyi!r&jw@1(o^RG z9eO(V>Ao;EOH{bmWSFCG_Qn!--qu4|ZAV*qe%Ub}=d~ZUc4Vs5UGJT3$2Hi%)6$&J zN?Mt`Xm1%kuUN?pv@*Y}n<4hFt?oOrXiD0yqdO$()~IQ+s($cwr_}4sU4fUs%uGozwqxAZEr48 z3{8=e!?F7{Z{>W|&N5O5FKn3A`AQ$Yg3^dKi&sp!`nd7XvR&@oJ=-2W2)9Z;_Mz19 zZr6^0&M5?u{YIuvyz|C_ZGtBijPU5fR*UDG1sZqRE2jo`SiXV^Hm6=6IJ zwL>md1&|(!@ILG8X_qSV!fCzFZ>f-VKOGb;FD3-@6I2eqnb4i#uAkNm8!%@CDBe^S ztl8_Uc2PZe=GDTv&W9E!#ot_LSu}?=Ys$&kQjBG6xzp`O=#xutw?5lpPEXo}MQ3W@ z-;#o+*1stW^b5=9EnPGFv>mCP_4+|V!qu;TsNXLAebQ-0M{x6@DeRTaH5Utwtw*k5A(G2Nn(Ju3}1kE88w&|7Ev)!s2>{+^2kHA_}}F01DE z(bKbens@rWb=M_y?p<9Nrj)XT8Q=)4517V1LijYVP&HtjZU}rw>AB`pk0{N@k^_17 zd_KIWjkR5#U9BQ_NN?jE)L0J?+~1zkh8`d|Xw(VUDbXvnYQkAaeO*6&{TvPZTbI0b z7h3liqn`1*7NjL;S3GS#K692*t;W2!58HNP-d@a`u04CvjeV09`Zf^mKQUdPI(5Q^ zTr-A&&Nbn_hPe}s&OWCpm!aQG*l(_V-7FOL9a_7tG1@Pi+ z5t9?QY`a(X$8~>J6ZTrki{H#(XkEwVsK@DW^v!u|<>l-z@NLILWdxKV1n{z|%rk-` z9Vkv%E`!I^Z-?@chbzrCDvZrt21@}B9LyKm7`?2lHUjuO8zUbg3u1-Y!y$a9Xff;= z?drviUdE;JjBM#BT9kEEXjmw6#0R261wx5+l#LM^DfwV) z$zj40u9zPt<%@)XOfH)vijdkE84cG|GTnnK<8g=eghhx216p`o5Ej6pvJwTvT4BLq z;WGI=u62+|9Lko`*B^93ttplkui?TAPj&A{mQ+ynams!C>nlrI&)KS+>?WeB9-kB+F9!DB68 z3xjQpqA)x-h#eu28qvK%_!0p5vH>ZKluO8~1t5qofd9_O?{y3q`JFj~yrVq!&7uJu zMveb(oM&6^kUIASvJ@67v9x)oAV^njhF%A|5|z#gGYD zJO&G4a1<|Oi{J>>$Sp(|HenRyk1~cz@&A*Q(X>Ny{xuIEn_z4YAQOlO@ZWm?8MJm6 zi+B-SSWIUi$Z^jN@Ub92^Bh<`URE9wmqh6NcrE z;{98k1|5$iT_od!!zusU{u{_r|Fyr71^?Gn0KiWr{|MZlaQ%eqA0hCMh<`@cPq_XO z0{@8kXLS8*aG^$uMx;MwV-$&$gkzNIe_yE&_EU!2DFn)3J5g4y{4ukG4c! z0xw#4Kv()Nxy(u_SKOpj_vc2h$%TKam=x`qeEX)nqMqEf$nk5(uw_)g@jv!fJ1wJ+)9ZbM}_28qbMpe)cZIYsE~p(O+` zS|{G<>dlI}T5gCm=YoTO<&A-XtOYjo>V52 - - 4.0.0 - - com.dropbox.sign_sandbox - DropboxSignSandbox - 1.0-SNAPSHOT - - - 11 - 11 - UTF-8 - - - - - com.dropbox.sign - dropbox-sign - ^2.0.0-beta - system - ${pom.basedir}/artifacts/dropbox-sign.jar - - - junit - junit - 4.13.1 - test - - - - diff --git a/sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java b/sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java deleted file mode 100644 index 16673775c..000000000 --- a/sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var oauth2 = (HttpBearerAuth) apiClient - .getAuthentication("oauth2"); - oauth2.setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var api = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = api.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling Dropbox Sign API"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json b/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore b/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java b/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java deleted file mode 100644 index d0df6afe9..000000000 --- a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java +++ /dev/null @@ -1,148 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiClient; -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.JSON; -import com.dropbox.sign.api.EmbeddedApi; -import com.dropbox.sign.api.SignatureRequestApi; -import com.dropbox.sign.model.*; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.ObjectReader; -import org.junit.Assert; -import org.junit.Test; - -import java.io.File; -import java.nio.file.Files; -import java.nio.file.Paths; - -public class SignatureRequestTest { - public static JsonNode getConfig() throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - - JsonNode configCustom = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.json") - )); - JsonNode configDist = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.dist.json") - )); - - ObjectReader updater = objectMapper.readerForUpdating(configDist); - - return updater.readValue(configCustom); - } - - public static JsonNode getJsonContents(String filename) throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - return objectMapper.readTree(Files.newInputStream( - Paths.get("test_fixtures/" + filename) - )); - } - - @Test - public void testSend() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestSend(sendRequest); - - Assert.assertEquals( - sendRequest.getFormFieldsPerDocument().get(0).getApiId(), - sendResponse.getSignatureRequest().getCustomFields().get(0).getApiId() - ); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - SignatureRequestGetResponse getResponse = signatureRequestApi.signatureRequestGet( - sendResponse.getSignatureRequest().getSignatureRequestId() - ); - - Assert.assertEquals( - sendResponse.getSignatureRequest().getSignatureRequestId(), - getResponse.getSignatureRequest().getSignatureRequestId() - ); - } - - @Test - public void testCreateEmbedded() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestCreateEmbeddedRequest.json"); - - SignatureRequestCreateEmbeddedRequest sendRequest = SignatureRequestCreateEmbeddedRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - sendRequest.clientId(config.findPath("CLIENT_ID").textValue()); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestCreateEmbedded(sendRequest); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - EmbeddedApi embeddedApi = new EmbeddedApi(apiClient); - - EmbeddedSignUrlResponse getResponse = embeddedApi.embeddedSignUrl( - sendResponse.getSignatureRequest().getSignatures().get(0).getSignatureId() - ); - - Assert.assertNotNull(getResponse.getEmbedded().getSignUrl()); - } - - @Test - public void testSendWithoutFileError() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - - try { - signatureRequestApi.signatureRequestSend(sendRequest); - Assert.fail(); - } catch (ApiException e) { - Assert.assertEquals("file", e.getErrorResponse().getError().getErrorPath()); - } - } -} diff --git a/sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json b/sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v2/test_fixtures/pdf-sample.pdf b/sandbox/java-v2/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d41575b222e6778f87f9e9fd8da4f2b1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7945 zcmeHMdpuO@*C+SMluP1J*&zvI@43%7V>Ap=#w8@A%w=P0%rG+|l|mN^ailm(Zs}e^ zN|F@npmOP+65Wq3lG43*4?-Qk^S<})*&y`N{@p6^=E+Rxf+hC9;{gSEn= zXLQ}a+=fPx0SFLrmZE7i(1kCA*^i3}2x43QZQ_BaS{X9wZ1_EbCr zqSG8n_Eel5o1%3!bAVS5^%S&?&k<5B6^tut*VOM^A~#N5&ZSVf z2aQ7D8xk-Cq(sUVOQXba5E=!cQ8Q*ZxH+Ox-@rwqaHD)S7ES<(I=mPP=n3E{-&q(K z7|0F`{B&7Pv7My8cWs)yNn^`e%ldJ3>gs6qcJ=nQX;Ra*lqPj`zi}FvBuhDYWx47u zrC-LdQwGdX?66=do5z;20qg)+?(AS#0uTqT2LQ82<^-bPkzk>Y@Y;)nQdlUJ0N6oh zd$B0YP88)2AtXd95ugxo0U!$r5B6V1kvKv)hZN0+C87v17g3BQ3}~J&k|N;)K!ZM$ z*)*abE0aEC{1_lQ^2HJh$A^`@cbFbvkoQ z+h-cB%`nYTRh^jdI9@ez>n2r4uL}wHOeW=;ss{UMb;cfg#B?g=OxL_;mRhW=Q*Tmn zB6qvD$JG|oY=cDv6v%xLL&)zae`{TmRTtl#aR1Gnnlf|DGnP`loIfE&Nx7LdQg7Om7{`#=?4z1;0f%4eLVHE53%MHtXmvZ_xX+Dk%nvCmYVkRwh4XiMSY~wh|{ba z?qVr@(v+zaf0<~bk<)sjbrECnjnvofxvH6VQv(>ojKT!$|c?M%+5GMRQo zz?$rrrb`Z6vilmO9~Ek-J15^Pk*_aXknVhprA%)QzQ;F-RcQ*uIo)on6ofuGajBF8 z?b}or>LL;>ck|R1bb>Ks@+^a3pm?%U(;9wKHKlS&T($c^JV;A^VOF+nqRH{oM*WE z)3uXerMB+w^cNFARe#Lo*RAw3j0+tKHzMU4r=4k-vo=e4?NLvtXrEz}(L-|7wXU#rvj%T0Dy>+XlXu5oroS`>cr>*2iZPG-w=oD<`__WSWutgFXy?N8CF%rbU zhW^i+Y$)SmiFjyaFF7Ta`OFjDCuuky`JyB7-=CmUWq4kCd{%QC$0B#5aAHZVi8-%D z<7wf0&(Fy_Rro7+Vo;WTitg|9#gDSHMD@1P?AwPMf%Pxg>663f&yHJzYiOk%K2R8U z@?dz*gXZVt<1a(i;vaI=Zm=aE+rU}0TNg=*=_Utq4M>Fj`cD>B z;pO`Ip>yrqL%RIXEhNunWrw;@ktURnvLLlJ3c{&eQWj0f_&99 zXXA0&^6S2YW$wv~O!v*5b8dp<<%PtsvV)FAeX5tv6fae4nbu*xwGFDEytCXad0Ddc zY|o_dq%1{uiyN-f&N~DdFY)W$z5Dk%iI&|&t^ANFPi`6-yvy{zh(oW_wa@6(s_UWn z9(S!Q$mDp~LVAVqHv`(>6t zIzhP@8=&n7rmr+&sVulW4}E4Idsj40&U1V`-KVWruLX|lcwQB3C||-h@wJ%mv|2Y} zjr#|mFYb%HGQUJA%V+GY*NzYKaoX8xu;AE?4$1LTzdLl~rY~8NLx}cVXLBG|b8#ly zxhiZY$_&aq-^4I3c5-VeubFLpBxn;lsZ(fbenGq5Ijf-dUB2413Da{_#^s&S?wb7x zD*Bwn*%0Tt{(bR>_0z)7nFO9HKWI^LRJFc{Ue;E)kJ;(=`?2o#zdHWrN?45j6{RC7 zT-~a0gjKsT+1f?S>%8x3q?4YY$aC?Kp00hZj@DGzqU?t50QS5USA=x&I5ixvhK2_! zdSSZe;JWbLcO5e0yfy46Ug+JO)3aN7^70S8`NoDNi*0a$n~x=*cyi!r&jw@1(o^RG z9eO(V>Ao;EOH{bmWSFCG_Qn!--qu4|ZAV*qe%Ub}=d~ZUc4Vs5UGJT3$2Hi%)6$&J zN?Mt`Xm1%kuUN?pv@*Y}n<4hFt?oOrXiD0yqdO$()~IQ+s($cwr_}4sU4fUs%uGozwqxAZEr48 z3{8=e!?F7{Z{>W|&N5O5FKn3A`AQ$Yg3^dKi&sp!`nd7XvR&@oJ=-2W2)9Z;_Mz19 zZr6^0&M5?u{YIuvyz|C_ZGtBijPU5fR*UDG1sZqRE2jo`SiXV^Hm6=6IJ zwL>md1&|(!@ILG8X_qSV!fCzFZ>f-VKOGb;FD3-@6I2eqnb4i#uAkNm8!%@CDBe^S ztl8_Uc2PZe=GDTv&W9E!#ot_LSu}?=Ys$&kQjBG6xzp`O=#xutw?5lpPEXo}MQ3W@ z-;#o+*1stW^b5=9EnPGFv>mCP_4+|V!qu;TsNXLAebQ-0M{x6@DeRTaH5Utwtw*k5A(G2Nn(Ju3}1kE88w&|7Ev)!s2>{+^2kHA_}}F01DE z(bKbens@rWb=M_y?p<9Nrj)XT8Q=)4517V1LijYVP&HtjZU}rw>AB`pk0{N@k^_17 zd_KIWjkR5#U9BQ_NN?jE)L0J?+~1zkh8`d|Xw(VUDbXvnYQkAaeO*6&{TvPZTbI0b z7h3liqn`1*7NjL;S3GS#K692*t;W2!58HNP-d@a`u04CvjeV09`Zf^mKQUdPI(5Q^ zTr-A&&Nbn_hPe}s&OWCpm!aQG*l(_V-7FOL9a_7tG1@Pi+ z5t9?QY`a(X$8~>J6ZTrki{H#(XkEwVsK@DW^v!u|<>l-z@NLILWdxKV1n{z|%rk-` z9Vkv%E`!I^Z-?@chbzrCDvZrt21@}B9LyKm7`?2lHUjuO8zUbg3u1-Y!y$a9Xff;= z?drviUdE;JjBM#BT9kEEXjmw6#0R261wx5+l#LM^DfwV) z$zj40u9zPt<%@)XOfH)vijdkE84cG|GTnnK<8g=eghhx216p`o5Ej6pvJwTvT4BLq z;WGI=u62+|9Lko`*B^93ttplkui?TAPj&A{mQ+ynams!C>nlrI&)KS+>?WeB9-kB+F9!DB68 z3xjQpqA)x-h#eu28qvK%_!0p5vH>ZKluO8~1t5qofd9_O?{y3q`JFj~yrVq!&7uJu zMveb(oM&6^kUIASvJ@67v9x)oAV^njhF%A|5|z#gGYD zJO&G4a1<|Oi{J>>$Sp(|HenRyk1~cz@&A*Q(X>Ny{xuIEn_z4YAQOlO@ZWm?8MJm6 zi+B-SSWIUi$Z^jN@Ub92^Bh<`URE9wmqh6NcrE z;{98k1|5$iT_od!!zusU{u{_r|Fyr71^?Gn0KiWr{|MZlaQ%eqA0hCMh<`@cPq_XO z0{@8kXLS8*aG^$uMx;MwV-$&$gkzNIe_yE&_EU!2DFn)3J5g4y{4ukG4c! z0xw#4Kv()Nxy(u_SKOpj_vc2h$%TKam=x`qeEX)nqMqEf$nk5(uw_)g@jv!fJ1wJ+)9ZbM}_28qbMpe)cZIYsE~p(O+` zS|{G<>dlI}T5gCm=YoTO<&A-XtOYjo>V52 + + + + + + diff --git a/sandbox/java/build.gradle b/sandbox/java/build.gradle new file mode 100644 index 000000000..c9961ae6e --- /dev/null +++ b/sandbox/java/build.gradle @@ -0,0 +1,109 @@ +apply plugin: 'idea' +apply plugin: 'eclipse' +apply plugin: 'java' +apply plugin: 'com.diffplug.spotless' + +group = 'com.dropbox.sign_sandbox' +version = '1.0.0' + +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath 'com.android.tools.build:gradle:2.3.+' + classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' + classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.11.0' + } +} + +repositories { + mavenCentral() +} +sourceSets { + main.java.srcDirs = ['src/main/java'] +} + +apply plugin: 'java' +apply plugin: 'maven-publish' + +publishing { + publications { + maven(MavenPublication) { + artifactId = 'dropbox-sign' + from components.java + } + } +} + +task execute(type:JavaExec) { + main = System.getProperty('mainClass') + classpath = sourceSets.main.runtimeClasspath +} + +ext { + jakarta_annotation_version = "1.3.5" +} + +dependencies { + implementation fileTree(dir: 'artifacts', include: ['dropbox-sign.jar']) + implementation 'io.swagger:swagger-annotations:1.6.8' + implementation "com.google.code.findbugs:jsr305:3.0.2" + implementation 'com.squareup.okhttp3:okhttp:4.12.0' + implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0' + implementation 'com.google.code.gson:gson:2.9.1' + implementation 'io.gsonfire:gson-fire:1.9.0' + implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6' + implementation 'org.openapitools:jackson-databind-nullable:0.2.6' + implementation group: 'org.apache.oltu.oauth2', name: 'org.apache.oltu.oauth2.client', version: '1.0.2' + implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.17.0' + implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version" + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.3' + testImplementation 'org.mockito:mockito-core:3.12.4' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.3' +} + +javadoc { + options.tags = [ "http.response.details:a:Http Response Details" ] +} + +// Use spotless plugin to automatically format code, remove unused import, etc +// To apply changes directly to the file, run `gradlew spotlessApply` +// Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle +spotless { + // comment out below to run spotless as part of the `check` task + enforceCheck false + + format 'misc', { + // define the files (e.g. '*.gradle', '*.md') to apply `misc` to + target '.gitignore' + + // define the steps to apply to those files + trimTrailingWhitespace() + indentWithSpaces() // Takes an integer argument if you don't like 4 + endWithNewline() + } + java { + // don't need to set target, it is inferred from java + + // apply a specific flavor of google-java-format + googleJavaFormat('1.8').aosp().reflowLongStrings() + + removeUnusedImports() + importOrder() + } +} + +test { + // Enable JUnit 5 (Gradle 4.6+). + useJUnitPlatform() + + // Always run tests, even when nothing changed. + dependsOn 'cleanTest' + + // Show test results. + testLogging { + events "passed", "skipped", "failed" + } + +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java new file mode 100644 index 000000000..a9b8c52d2 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java new file mode 100644 index 000000000..5cfc13531 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateOauthExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + accountCreateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + accountCreateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java new file mode 100644 index 000000000..3a90b0375 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java new file mode 100644 index 000000000..ac9c0d227 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java new file mode 100644 index 000000000..6d6f22f72 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountVerifyExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountVerify"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java new file mode 100644 index 000000000..9422376ae --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java @@ -0,0 +1,60 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java new file mode 100644 index 000000000..f9f7c5c9f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java new file mode 100644 index 000000000..6a8330449 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java new file mode 100644 index 000000000..5f023c890 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java new file mode 100644 index 000000000..19eb17192 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java @@ -0,0 +1,62 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java new file mode 100644 index 000000000..a90b43560 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java new file mode 100644 index 000000000..fc5d223e3 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java new file mode 100644 index 000000000..81139263b --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java @@ -0,0 +1,49 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedEditUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java new file mode 100644 index 000000000..8b58ba353 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedSignUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedSignUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java new file mode 100644 index 000000000..37d245133 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java @@ -0,0 +1,39 @@ +import com.dropbox.sign.EventCallbackHelper; +import com.dropbox.sign.model.EventCallbackRequest; +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.util.HashMap; + +public class EventCallbackExample { + public static void main(String[] args) throws Exception { + // use your API key + var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; + + // callbackData represents data we send to you + var callbackData = new HashMap<>() {{ + put("event", new HashMap<>() {{ + put("event_type", "account_confirmed"); + put("event_time", "1669926463"); + put("event_hash", "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f"); + put("event_metadata", new HashMap<>() {{ + put("related_signature_id", null); + put("reported_for_account_id", "6421d70b9bd45059fa207d03ab8d1b96515b472c"); + put("reported_for_app_id", null); + put("event_message", null); + }}); + }}); + }}; + + var callbackEvent = EventCallbackRequest.init( + new ObjectMapper().writeValueAsString(callbackData) + ); + + // verify that a callback came from HelloSign.com + if (EventCallbackHelper.isValid(apiKey, callbackEvent)) { + // one of "account_callback" or "api_app_callback" + var callbackType = EventCallbackHelper.getCallbackType(callbackEvent); + + // do your magic below! + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java new file mode 100644 index 000000000..ac5fc888d --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java new file mode 100644 index 000000000..1d2e62fac --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java new file mode 100644 index 000000000..3db05bd4b --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java new file mode 100644 index 000000000..f3883223f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java new file mode 100644 index 000000000..0f2055863 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java new file mode 100644 index 000000000..d1a1fa689 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java new file mode 100644 index 000000000..348833fba --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java new file mode 100644 index 000000000..8f9cd3169 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java new file mode 100644 index 000000000..7ce8cf1cf --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java new file mode 100644 index 000000000..568d08d5d --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java new file mode 100644 index 000000000..1ca7c0a54 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java new file mode 100644 index 000000000..62696b80d --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java @@ -0,0 +1,51 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java new file mode 100644 index 000000000..c8c8cea26 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java @@ -0,0 +1,6 @@ +package com.dropbox.sign_sandbox; + +public class Main { + public static void main(String[] args) { + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java new file mode 100644 index 000000000..7c51af01f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenGenerate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java new file mode 100644 index 000000000..5b2133b0e --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenRefresh"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java new file mode 100644 index 000000000..ecd726bcb --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java @@ -0,0 +1,47 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ReportApi#reportCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..fcfbef591 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java new file mode 100644 index 000000000..fb9baba01 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java new file mode 100644 index 000000000..a1e436802 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCancelExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCancel"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java new file mode 100644 index 000000000..ee5f5bb2a --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java @@ -0,0 +1,78 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..0228be4a6 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -0,0 +1,104 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..5957ccba0 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java new file mode 100644 index 000000000..8370a232e --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java @@ -0,0 +1,79 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..8859b04f8 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -0,0 +1,105 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..77c294dea --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -0,0 +1,68 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java new file mode 100644 index 000000000..c0423f9b9 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java @@ -0,0 +1,88 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java new file mode 100644 index 000000000..693b72c6c --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java @@ -0,0 +1,114 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java new file mode 100644 index 000000000..bcb4128d6 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java new file mode 100644 index 000000000..765fb93ce --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java new file mode 100644 index 000000000..62e253779 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java new file mode 100644 index 000000000..758d2997b --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java new file mode 100644 index 000000000..b93d099d6 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java new file mode 100644 index 000000000..76f018548 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java new file mode 100644 index 000000000..521794ef1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestReleaseHoldExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestReleaseHold"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java new file mode 100644 index 000000000..23830d9d3 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemindExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemind"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java new file mode 100644 index 000000000..d205e388a --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemove"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java new file mode 100644 index 000000000..2a57da157 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java new file mode 100644 index 000000000..14d6d0fba --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java @@ -0,0 +1,113 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java new file mode 100644 index 000000000..fe3a4ce83 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java @@ -0,0 +1,86 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java new file mode 100644 index 000000000..ef9873326 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java new file mode 100644 index 000000000..cdeea5ec5 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java new file mode 100644 index 000000000..788cc3bd0 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java new file mode 100644 index 000000000..0b72d53e2 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java new file mode 100644 index 000000000..f39d1324c --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java @@ -0,0 +1,36 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TeamApi(config).teamDelete(); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java new file mode 100644 index 000000000..4356bb8a9 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java new file mode 100644 index 000000000..8b5718628 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInfoExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java new file mode 100644 index 000000000..204109825 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInvitesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInvites"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java new file mode 100644 index 000000000..bc709c951 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamMembersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamMembers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java new file mode 100644 index 000000000..85c46ee65 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java new file mode 100644 index 000000000..40938583f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java new file mode 100644 index 000000000..f0ee98cf1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamSubTeamsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamSubTeams"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java new file mode 100644 index 000000000..54f6bf2a1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java new file mode 100644 index 000000000..144cb00ef --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java new file mode 100644 index 000000000..cb8c9ce12 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java @@ -0,0 +1,85 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java new file mode 100644 index 000000000..61c6fc967 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldGroups(formFieldGroups); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java new file mode 100644 index 000000000..7bb877263 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldRules(formFieldRules); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..38e8fccbc --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java new file mode 100644 index 000000000..b8b8e5150 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..08612bd26 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldGroups(formFieldGroups); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java new file mode 100644 index 000000000..a3c621aee --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldRules(formFieldRules); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..397046a78 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java new file mode 100644 index 000000000..b9d0b77ad --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java new file mode 100644 index 000000000..6ef950fe3 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java new file mode 100644 index 000000000..3ac688da1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java new file mode 100644 index 000000000..90c2975b2 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java new file mode 100644 index 000000000..affbf4d04 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java new file mode 100644 index 000000000..45250a456 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java new file mode 100644 index 000000000..d3d157b24 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java new file mode 100644 index 000000000..865668461 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java @@ -0,0 +1,46 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateUpdateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateUpdateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java new file mode 100644 index 000000000..0dfd50d88 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java @@ -0,0 +1,48 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java new file mode 100644 index 000000000..f597e3e18 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java @@ -0,0 +1,94 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java new file mode 100644 index 000000000..d2483f32f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java @@ -0,0 +1,110 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..f425a3d36 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java @@ -0,0 +1,82 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..174c678a4 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java new file mode 100644 index 000000000..219de1f5a --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java @@ -0,0 +1,57 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..e30a749bb --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java @@ -0,0 +1,93 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java new file mode 100644 index 000000000..49de71fbe --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java @@ -0,0 +1,109 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..b048a8ba9 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,81 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java new file mode 100644 index 000000000..4866e6524 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftEditAndResendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/node/.gitignore b/sandbox/node/.gitignore new file mode 100644 index 000000000..bf28e3a64 --- /dev/null +++ b/sandbox/node/.gitignore @@ -0,0 +1,32 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env.local +.env.development.local +.env.test.local +.env.production.local + +package-lock.json diff --git a/sandbox/node/Example.ts b/sandbox/node/Example.ts deleted file mode 100644 index af5e5b01d..000000000 --- a/sandbox/node/Example.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const api = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -api.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// api.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountCreateRequest = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = api.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/sandbox/node/package.json b/sandbox/node/package.json index 8506e51c3..11d5ee311 100644 --- a/sandbox/node/package.json +++ b/sandbox/node/package.json @@ -1,21 +1,15 @@ { "name": "@dropbox/sign-sandbox", "version": "1.0.0", - "description": "", - "main": "Example.ts", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "dependencies": { "@dropbox/sign": "file:./artifacts/dropbox-sign-sdk.tgz", - "@types/jest": "^29.5.7", - "@types/node": "^20.8.10", - "jest": "^29.7.0", - "ts-jest": "^29.1.1", - "ts-node": "^10.9.1", - "typescript": "^4.0 || ^5.0" + "@types/node": "^22.12", + "ts-node": "^10.9", + "typescript": "^5.0" }, "type": "module", - "author": "", "license": "ISC" } diff --git a/sandbox/node/src/AccountCreateExample.ts b/sandbox/node/src/AccountCreateExample.ts new file mode 100644 index 000000000..f5b490085 --- /dev/null +++ b/sandbox/node/src/AccountCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountCreateOauthExample.ts b/sandbox/node/src/AccountCreateOauthExample.ts new file mode 100644 index 000000000..0554d4d79 --- /dev/null +++ b/sandbox/node/src/AccountCreateOauthExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; +accountCreateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +accountCreateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountGetExample.ts b/sandbox/node/src/AccountGetExample.ts new file mode 100644 index 000000000..6bc7ae2de --- /dev/null +++ b/sandbox/node/src/AccountGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.accountGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountUpdateExample.ts b/sandbox/node/src/AccountUpdateExample.ts new file mode 100644 index 000000000..8a546ee0e --- /dev/null +++ b/sandbox/node/src/AccountUpdateExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountUpdateRequest = new models.AccountUpdateRequest(); +accountUpdateRequest.callbackUrl = "https://www.example.com/callback"; +accountUpdateRequest.locale = "en-US"; + +apiCaller.accountUpdate( + accountUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountVerifyExample.ts b/sandbox/node/src/AccountVerifyExample.ts new file mode 100644 index 000000000..417ffce6d --- /dev/null +++ b/sandbox/node/src/AccountVerifyExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountVerifyRequest = new models.AccountVerifyRequest(); +accountVerifyRequest.emailAddress = "some_user@dropboxsign.com"; + +apiCaller.accountVerify( + accountVerifyRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountVerify:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppCreateExample.ts b/sandbox/node/src/ApiAppCreateExample.ts new file mode 100644 index 000000000..be9234816 --- /dev/null +++ b/sandbox/node/src/ApiAppCreateExample.ts @@ -0,0 +1,36 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppCreateRequest = new models.ApiAppCreateRequest(); +apiAppCreateRequest.name = "My Production App"; +apiAppCreateRequest.domains = [ + "example.com", +]; +apiAppCreateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppCreateRequest.oauth = oauth; +apiAppCreateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppCreate( + apiAppCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppDeleteExample.ts b/sandbox/node/src/ApiAppDeleteExample.ts new file mode 100644 index 000000000..1ffefb975 --- /dev/null +++ b/sandbox/node/src/ApiAppDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppGetExample.ts b/sandbox/node/src/ApiAppGetExample.ts new file mode 100644 index 000000000..4899769af --- /dev/null +++ b/sandbox/node/src/ApiAppGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppListExample.ts b/sandbox/node/src/ApiAppListExample.ts new file mode 100644 index 000000000..7304a9d1c --- /dev/null +++ b/sandbox/node/src/ApiAppListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppUpdateExample.ts b/sandbox/node/src/ApiAppUpdateExample.ts new file mode 100644 index 000000000..fa8937223 --- /dev/null +++ b/sandbox/node/src/ApiAppUpdateExample.ts @@ -0,0 +1,38 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppUpdateRequest = new models.ApiAppUpdateRequest(); +apiAppUpdateRequest.callbackUrl = "https://example.com/dropboxsign"; +apiAppUpdateRequest.name = "New Name"; +apiAppUpdateRequest.domains = [ + "example.com", +]; +apiAppUpdateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppUpdateRequest.oauth = oauth; +apiAppUpdateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/BulkSendJobGetExample.ts b/sandbox/node/src/BulkSendJobGetExample.ts new file mode 100644 index 000000000..9c3e43eb9 --- /dev/null +++ b/sandbox/node/src/BulkSendJobGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/BulkSendJobListExample.ts b/sandbox/node/src/BulkSendJobListExample.ts new file mode 100644 index 000000000..4f8b1b33b --- /dev/null +++ b/sandbox/node/src/BulkSendJobListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/EmbeddedEditUrlExample.ts b/sandbox/node/src/EmbeddedEditUrlExample.ts new file mode 100644 index 000000000..bca3980cf --- /dev/null +++ b/sandbox/node/src/EmbeddedEditUrlExample.ts @@ -0,0 +1,26 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const mergeFields = [ +]; + +const embeddedEditUrlRequest = new models.EmbeddedEditUrlRequest(); +embeddedEditUrlRequest.ccRoles = [ + "", +]; +embeddedEditUrlRequest.mergeFields = mergeFields; + +apiCaller.embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedEditUrl:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/EmbeddedSignUrlExample.ts b/sandbox/node/src/EmbeddedSignUrlExample.ts new file mode 100644 index 000000000..ec7da0536 --- /dev/null +++ b/sandbox/node/src/EmbeddedSignUrlExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", // signatureId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedSignUrl:"); + console.log(error.body); +}); diff --git a/examples/EventCallback.ts b/sandbox/node/src/EventCallbackExample.ts similarity index 100% rename from examples/EventCallback.ts rename to sandbox/node/src/EventCallbackExample.ts diff --git a/sandbox/node/src/FaxDeleteExample.ts b/sandbox/node/src/FaxDeleteExample.ts new file mode 100644 index 000000000..3afd7a63b --- /dev/null +++ b/sandbox/node/src/FaxDeleteExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).catch(error => { + console.log("Exception when calling FaxApi#faxDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxFilesExample.ts b/sandbox/node/src/FaxFilesExample.ts new file mode 100644 index 000000000..d4360710d --- /dev/null +++ b/sandbox/node/src/FaxFilesExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxGetExample.ts b/sandbox/node/src/FaxGetExample.ts new file mode 100644 index 000000000..56a87dbe7 --- /dev/null +++ b/sandbox/node/src/FaxGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineAddUserExample.ts b/sandbox/node/src/FaxLineAddUserExample.ts new file mode 100644 index 000000000..468fe36a6 --- /dev/null +++ b/sandbox/node/src/FaxLineAddUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineAddUserRequest = new models.FaxLineAddUserRequest(); +faxLineAddUserRequest.number = "[FAX_NUMBER]"; +faxLineAddUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineAddUser( + faxLineAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAddUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineAreaCodeGetExample.ts b/sandbox/node/src/FaxLineAreaCodeGetExample.ts new file mode 100644 index 000000000..0abb378b3 --- /dev/null +++ b/sandbox/node/src/FaxLineAreaCodeGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineAreaCodeGet( + "US", // country + undefined, // state + undefined, // province + undefined, // city +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAreaCodeGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineCreateExample.ts b/sandbox/node/src/FaxLineCreateExample.ts new file mode 100644 index 000000000..b9398b2fa --- /dev/null +++ b/sandbox/node/src/FaxLineCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineCreateRequest = new models.FaxLineCreateRequest(); +faxLineCreateRequest.areaCode = 209; +faxLineCreateRequest.country = models.FaxLineCreateRequest.CountryEnum.Us; + +apiCaller.faxLineCreate( + faxLineCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineDeleteExample.ts b/sandbox/node/src/FaxLineDeleteExample.ts new file mode 100644 index 000000000..72b2279a3 --- /dev/null +++ b/sandbox/node/src/FaxLineDeleteExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineDeleteRequest = new models.FaxLineDeleteRequest(); +faxLineDeleteRequest.number = "[FAX_NUMBER]"; + +apiCaller.faxLineDelete( + faxLineDeleteRequest, +).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineGetExample.ts b/sandbox/node/src/FaxLineGetExample.ts new file mode 100644 index 000000000..e5ee2fd0f --- /dev/null +++ b/sandbox/node/src/FaxLineGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineGet( + "123-123-1234", // number +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineListExample.ts b/sandbox/node/src/FaxLineListExample.ts new file mode 100644 index 000000000..aa547afce --- /dev/null +++ b/sandbox/node/src/FaxLineListExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + undefined, // showTeamLines +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineRemoveUserExample.ts b/sandbox/node/src/FaxLineRemoveUserExample.ts new file mode 100644 index 000000000..e73b8c7c5 --- /dev/null +++ b/sandbox/node/src/FaxLineRemoveUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineRemoveUserRequest = new models.FaxLineRemoveUserRequest(); +faxLineRemoveUserRequest.number = "[FAX_NUMBER]"; +faxLineRemoveUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineRemoveUser( + faxLineRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineRemoveUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxListExample.ts b/sandbox/node/src/FaxListExample.ts new file mode 100644 index 000000000..70b904d6f --- /dev/null +++ b/sandbox/node/src/FaxListExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxSendExample.ts b/sandbox/node/src/FaxSendExample.ts new file mode 100644 index 000000000..0b39faee5 --- /dev/null +++ b/sandbox/node/src/FaxSendExample.ts @@ -0,0 +1,27 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxSendRequest = new models.FaxSendRequest(); +faxSendRequest.recipient = "16690000001"; +faxSendRequest.sender = "16690000000"; +faxSendRequest.testMode = true; +faxSendRequest.coverPageTo = "Jill Fax"; +faxSendRequest.coverPageFrom = "Faxer Faxerson"; +faxSendRequest.coverPageMessage = "I'm sending you a fax!"; +faxSendRequest.title = "This is what the fax is about!"; +faxSendRequest.files = [ + fs.createReadStream("./example_fax.pdf"), +]; + +apiCaller.faxSend( + faxSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxSend:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/OauthTokenGenerateExample.ts b/sandbox/node/src/OauthTokenGenerateExample.ts new file mode 100644 index 000000000..ace0df01d --- /dev/null +++ b/sandbox/node/src/OauthTokenGenerateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenGenerateRequest = new models.OAuthTokenGenerateRequest(); +oAuthTokenGenerateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +oAuthTokenGenerateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; +oAuthTokenGenerateRequest.code = "1b0d28d90c86c141"; +oAuthTokenGenerateRequest.state = "900e06e2"; +oAuthTokenGenerateRequest.grantType = "authorization_code"; + +apiCaller.oauthTokenGenerate( + oAuthTokenGenerateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenGenerate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/OauthTokenRefreshExample.ts b/sandbox/node/src/OauthTokenRefreshExample.ts new file mode 100644 index 000000000..fa9973e6f --- /dev/null +++ b/sandbox/node/src/OauthTokenRefreshExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenRefreshRequest = new models.OAuthTokenRefreshRequest(); +oAuthTokenRefreshRequest.grantType = "refresh_token"; +oAuthTokenRefreshRequest.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; + +apiCaller.oauthTokenRefresh( + oAuthTokenRefreshRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenRefresh:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ReportCreateExample.ts b/sandbox/node/src/ReportCreateExample.ts new file mode 100644 index 000000000..57bf8127d --- /dev/null +++ b/sandbox/node/src/ReportCreateExample.ts @@ -0,0 +1,23 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ReportApi(); +apiCaller.username = "YOUR_API_KEY"; + +const reportCreateRequest = new models.ReportCreateRequest(); +reportCreateRequest.startDate = "09/01/2020"; +reportCreateRequest.endDate = "09/01/2020"; +reportCreateRequest.reportType = [ + models.ReportCreateRequest.ReportTypeEnum.UserActivity, + models.ReportCreateRequest.ReportTypeEnum.DocumentStatus, +]; + +apiCaller.reportCreate( + reportCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ReportApi#reportCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..d8b5b2ef9 --- /dev/null +++ b/sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkCreateEmbeddedWithTemplateRequest = new models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); +signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId = "1a659d9ad95bccd307ecad78d72192f8"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList = signerList; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts b/sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts new file mode 100644 index 000000000..f2fff90b1 --- /dev/null +++ b/sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkSendWithTemplateRequest = new models.SignatureRequestBulkSendWithTemplateRequest(); +signatureRequestBulkSendWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkSendWithTemplateRequest.testMode = true; +signatureRequestBulkSendWithTemplateRequest.signerList = signerList; +signatureRequestBulkSendWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCancelExample.ts b/sandbox/node/src/SignatureRequestCancelExample.ts new file mode 100644 index 000000000..d6207b3bd --- /dev/null +++ b/sandbox/node/src/SignatureRequestCancelExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCancel:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts new file mode 100644 index 000000000..15c30c113 --- /dev/null +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts @@ -0,0 +1,54 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..6fcc1bab3 --- /dev/null +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts @@ -0,0 +1,80 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..399f0c491 --- /dev/null +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestCreateEmbeddedWithTemplateRequest = new models.SignatureRequestCreateEmbeddedWithTemplateRequest(); +signatureRequestCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts new file mode 100644 index 000000000..6affce8fb --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts @@ -0,0 +1,55 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..c65767fed --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts @@ -0,0 +1,81 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..6da9e8e05 --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts @@ -0,0 +1,44 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestEditEmbeddedWithTemplateRequest = new models.SignatureRequestEditEmbeddedWithTemplateRequest(); +signatureRequestEditEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestEditEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditEmbeddedWithTemplateRequest.testMode = true; +signatureRequestEditEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditExample.ts b/sandbox/node/src/SignatureRequestEditExample.ts new file mode 100644 index 000000000..43aca782d --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.signers = signers; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts new file mode 100644 index 000000000..fe5e19645 --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts @@ -0,0 +1,88 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditWithTemplateExample.ts b/sandbox/node/src/SignatureRequestEditWithTemplateExample.ts new file mode 100644 index 000000000..650ce2ff1 --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditWithTemplateExample.ts @@ -0,0 +1,63 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestEditWithTemplateRequest = new models.SignatureRequestEditWithTemplateRequest(); +signatureRequestEditWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestEditWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditWithTemplateRequest.testMode = true; +signatureRequestEditWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditWithTemplateRequest.signers = signers; +signatureRequestEditWithTemplateRequest.ccs = ccs; +signatureRequestEditWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts b/sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts new file mode 100644 index 000000000..58630aeaa --- /dev/null +++ b/sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts b/sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts new file mode 100644 index 000000000..5ca65d932 --- /dev/null +++ b/sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestFilesExample.ts b/sandbox/node/src/SignatureRequestFilesExample.ts new file mode 100644 index 000000000..88762904f --- /dev/null +++ b/sandbox/node/src/SignatureRequestFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf", // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestGetExample.ts b/sandbox/node/src/SignatureRequestGetExample.ts new file mode 100644 index 000000000..05ea209b6 --- /dev/null +++ b/sandbox/node/src/SignatureRequestGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestListExample.ts b/sandbox/node/src/SignatureRequestListExample.ts new file mode 100644 index 000000000..20d63eddb --- /dev/null +++ b/sandbox/node/src/SignatureRequestListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestReleaseHoldExample.ts b/sandbox/node/src/SignatureRequestReleaseHoldExample.ts new file mode 100644 index 000000000..3dca1e10d --- /dev/null +++ b/sandbox/node/src/SignatureRequestReleaseHoldExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestReleaseHold:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestRemindExample.ts b/sandbox/node/src/SignatureRequestRemindExample.ts new file mode 100644 index 000000000..fa558c1d6 --- /dev/null +++ b/sandbox/node/src/SignatureRequestRemindExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestRemindRequest = new models.SignatureRequestRemindRequest(); +signatureRequestRemindRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemind:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestRemoveExample.ts b/sandbox/node/src/SignatureRequestRemoveExample.ts new file mode 100644 index 000000000..7f76eb5a2 --- /dev/null +++ b/sandbox/node/src/SignatureRequestRemoveExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemove:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestSendExample.ts b/sandbox/node/src/SignatureRequestSendExample.ts new file mode 100644 index 000000000..c742336fa --- /dev/null +++ b/sandbox/node/src/SignatureRequestSendExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.signers = signers; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts new file mode 100644 index 000000000..d7414588a --- /dev/null +++ b/sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts @@ -0,0 +1,87 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts b/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts new file mode 100644 index 000000000..181e37a35 --- /dev/null +++ b/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestSendWithTemplateRequest = new models.SignatureRequestSendWithTemplateRequest(); +signatureRequestSendWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestSendWithTemplateRequest.testMode = true; +signatureRequestSendWithTemplateRequest.signingOptions = signingOptions; +signatureRequestSendWithTemplateRequest.signers = signers; +signatureRequestSendWithTemplateRequest.ccs = ccs; +signatureRequestSendWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestUpdateExample.ts b/sandbox/node/src/SignatureRequestUpdateExample.ts new file mode 100644 index 000000000..fa02e0345 --- /dev/null +++ b/sandbox/node/src/SignatureRequestUpdateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestUpdateRequest = new models.SignatureRequestUpdateRequest(); +signatureRequestUpdateRequest.signatureId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +signatureRequestUpdateRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamAddMemberAccountIdExample.ts b/sandbox/node/src/TeamAddMemberAccountIdExample.ts new file mode 100644 index 000000000..6aedbc340 --- /dev/null +++ b/sandbox/node/src/TeamAddMemberAccountIdExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamAddMemberExample.ts b/sandbox/node/src/TeamAddMemberExample.ts new file mode 100644 index 000000000..0ffde9292 --- /dev/null +++ b/sandbox/node/src/TeamAddMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.emailAddress = "george@example.com"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamCreateExample.ts b/sandbox/node/src/TeamCreateExample.ts new file mode 100644 index 000000000..22ad05f83 --- /dev/null +++ b/sandbox/node/src/TeamCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamCreateRequest = new models.TeamCreateRequest(); +teamCreateRequest.name = "New Team Name"; + +apiCaller.teamCreate( + teamCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamDeleteExample.ts b/sandbox/node/src/TeamDeleteExample.ts new file mode 100644 index 000000000..c37216b0c --- /dev/null +++ b/sandbox/node/src/TeamDeleteExample.ts @@ -0,0 +1,12 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamDelete().catch(error => { + console.log("Exception when calling TeamApi#teamDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamGetExample.ts b/sandbox/node/src/TeamGetExample.ts new file mode 100644 index 000000000..65d8758fc --- /dev/null +++ b/sandbox/node/src/TeamGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamInfoExample.ts b/sandbox/node/src/TeamInfoExample.ts new file mode 100644 index 000000000..d0050e94c --- /dev/null +++ b/sandbox/node/src/TeamInfoExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInfo:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamInvitesExample.ts b/sandbox/node/src/TeamInvitesExample.ts new file mode 100644 index 000000000..7debb4877 --- /dev/null +++ b/sandbox/node/src/TeamInvitesExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInvites().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInvites:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamMembersExample.ts b/sandbox/node/src/TeamMembersExample.ts new file mode 100644 index 000000000..17479dbda --- /dev/null +++ b/sandbox/node/src/TeamMembersExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamMembers:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamRemoveMemberAccountIdExample.ts b/sandbox/node/src/TeamRemoveMemberAccountIdExample.ts new file mode 100644 index 000000000..e170817b3 --- /dev/null +++ b/sandbox/node/src/TeamRemoveMemberAccountIdExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamRemoveMemberExample.ts b/sandbox/node/src/TeamRemoveMemberExample.ts new file mode 100644 index 000000000..efd33d694 --- /dev/null +++ b/sandbox/node/src/TeamRemoveMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.emailAddress = "teammate@dropboxsign.com"; +teamRemoveMemberRequest.newOwnerEmailAddress = "new_teammate@dropboxsign.com"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamSubTeamsExample.ts b/sandbox/node/src/TeamSubTeamsExample.ts new file mode 100644 index 000000000..e6ef9c8da --- /dev/null +++ b/sandbox/node/src/TeamSubTeamsExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamSubTeams:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamUpdateExample.ts b/sandbox/node/src/TeamUpdateExample.ts new file mode 100644 index 000000000..0e32bcdd4 --- /dev/null +++ b/sandbox/node/src/TeamUpdateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamUpdateRequest = new models.TeamUpdateRequest(); +teamUpdateRequest.name = "New Team Name"; + +apiCaller.teamUpdate( + teamUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateAddUserExample.ts b/sandbox/node/src/TemplateAddUserExample.ts new file mode 100644 index 000000000..f801c3e65 --- /dev/null +++ b/sandbox/node/src/TemplateAddUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateAddUserRequest = new models.TemplateAddUserRequest(); +templateAddUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateAddUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts new file mode 100644 index 000000000..6371fcd18 --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts new file mode 100644 index 000000000..5bdb6384f --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldGroups = formFieldGroups; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts new file mode 100644 index 000000000..ce20fc91d --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldRules = formFieldRules; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..0ce2cbcd4 --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateExample.ts b/sandbox/node/src/TemplateCreateExample.ts new file mode 100644 index 000000000..c17b780a9 --- /dev/null +++ b/sandbox/node/src/TemplateCreateExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts b/sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..e12c74953 --- /dev/null +++ b/sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldGroups = formFieldGroups; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateFormFieldRulesExample.ts b/sandbox/node/src/TemplateCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..31a949aea --- /dev/null +++ b/sandbox/node/src/TemplateCreateFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldRules = formFieldRules; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts b/sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..d580e665b --- /dev/null +++ b/sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateDeleteExample.ts b/sandbox/node/src/TemplateDeleteExample.ts new file mode 100644 index 000000000..3f0aae438 --- /dev/null +++ b/sandbox/node/src/TemplateDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateDelete( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).catch(error => { + console.log("Exception when calling TemplateApi#templateDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateFilesAsDataUriExample.ts b/sandbox/node/src/TemplateFilesAsDataUriExample.ts new file mode 100644 index 000000000..40a8e2ac0 --- /dev/null +++ b/sandbox/node/src/TemplateFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateFilesAsFileUrlExample.ts b/sandbox/node/src/TemplateFilesAsFileUrlExample.ts new file mode 100644 index 000000000..e80f1ad91 --- /dev/null +++ b/sandbox/node/src/TemplateFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateFilesExample.ts b/sandbox/node/src/TemplateFilesExample.ts new file mode 100644 index 000000000..923f16d56 --- /dev/null +++ b/sandbox/node/src/TemplateFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + undefined, // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateGetExample.ts b/sandbox/node/src/TemplateGetExample.ts new file mode 100644 index 000000000..b4fcdda6c --- /dev/null +++ b/sandbox/node/src/TemplateGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateGet( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateListExample.ts b/sandbox/node/src/TemplateListExample.ts new file mode 100644 index 000000000..e678a6c26 --- /dev/null +++ b/sandbox/node/src/TemplateListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateRemoveUserExample.ts b/sandbox/node/src/TemplateRemoveUserExample.ts new file mode 100644 index 000000000..f896f81e1 --- /dev/null +++ b/sandbox/node/src/TemplateRemoveUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateRemoveUserRequest = new models.TemplateRemoveUserRequest(); +templateRemoveUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateRemoveUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateUpdateFilesExample.ts b/sandbox/node/src/TemplateUpdateFilesExample.ts new file mode 100644 index 000000000..139a53fff --- /dev/null +++ b/sandbox/node/src/TemplateUpdateFilesExample.ts @@ -0,0 +1,22 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateUpdateFilesRequest = new models.TemplateUpdateFilesRequest(); +templateUpdateFilesRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateUpdateFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts new file mode 100644 index 000000000..d17be1564 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts @@ -0,0 +1,24 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = true; +unclaimedDraftCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts new file mode 100644 index 000000000..bb10352f4 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts @@ -0,0 +1,70 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts new file mode 100644 index 000000000..8223f693e --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts @@ -0,0 +1,86 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..66efc0596 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts @@ -0,0 +1,58 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..8e78741d8 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@dropboxsign.com"; + +const ccs = [ + ccs1, +]; + +const signers1 = new models.SubUnclaimedDraftTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateEmbeddedWithTemplateRequest = new models.UnclaimedDraftCreateEmbeddedWithTemplateRequest(); +unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode = false; +unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs = ccs; +unclaimedDraftCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateExample.ts b/sandbox/node/src/UnclaimedDraftCreateExample.ts new file mode 100644 index 000000000..dc23f50d2 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateExample.ts @@ -0,0 +1,33 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signers1 = new models.SubUnclaimedDraftSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = true; +unclaimedDraftCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +unclaimedDraftCreateRequest.signers = signers; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts b/sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..f3e47da2c --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts @@ -0,0 +1,69 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts b/sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..c4abba3b1 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts @@ -0,0 +1,85 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts b/sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..b5e61ab5a --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,57 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftEditAndResendExample.ts b/sandbox/node/src/UnclaimedDraftEditAndResendExample.ts new file mode 100644 index 000000000..16a998390 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftEditAndResendExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftEditAndResendRequest = new models.UnclaimedDraftEditAndResendRequest(); +unclaimedDraftEditAndResendRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftEditAndResendRequest.testMode = false; + +apiCaller.unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend:"); + console.log(error.body); +}); diff --git a/sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/node/test_fixtures/SignatureRequestSendRequest.json b/sandbox/node/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/node/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/node/test_fixtures/pdf-sample.pdf b/sandbox/node/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d41575b222e6778f87f9e9fd8da4f2b1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7945 zcmeHMdpuO@*C+SMluP1J*&zvI@43%7V>Ap=#w8@A%w=P0%rG+|l|mN^ailm(Zs}e^ zN|F@npmOP+65Wq3lG43*4?-Qk^S<})*&y`N{@p6^=E+Rxf+hC9;{gSEn= zXLQ}a+=fPx0SFLrmZE7i(1kCA*^i3}2x43QZQ_BaS{X9wZ1_EbCr zqSG8n_Eel5o1%3!bAVS5^%S&?&k<5B6^tut*VOM^A~#N5&ZSVf z2aQ7D8xk-Cq(sUVOQXba5E=!cQ8Q*ZxH+Ox-@rwqaHD)S7ES<(I=mPP=n3E{-&q(K z7|0F`{B&7Pv7My8cWs)yNn^`e%ldJ3>gs6qcJ=nQX;Ra*lqPj`zi}FvBuhDYWx47u zrC-LdQwGdX?66=do5z;20qg)+?(AS#0uTqT2LQ82<^-bPkzk>Y@Y;)nQdlUJ0N6oh zd$B0YP88)2AtXd95ugxo0U!$r5B6V1kvKv)hZN0+C87v17g3BQ3}~J&k|N;)K!ZM$ z*)*abE0aEC{1_lQ^2HJh$A^`@cbFbvkoQ z+h-cB%`nYTRh^jdI9@ez>n2r4uL}wHOeW=;ss{UMb;cfg#B?g=OxL_;mRhW=Q*Tmn zB6qvD$JG|oY=cDv6v%xLL&)zae`{TmRTtl#aR1Gnnlf|DGnP`loIfE&Nx7LdQg7Om7{`#=?4z1;0f%4eLVHE53%MHtXmvZ_xX+Dk%nvCmYVkRwh4XiMSY~wh|{ba z?qVr@(v+zaf0<~bk<)sjbrECnjnvofxvH6VQv(>ojKT!$|c?M%+5GMRQo zz?$rrrb`Z6vilmO9~Ek-J15^Pk*_aXknVhprA%)QzQ;F-RcQ*uIo)on6ofuGajBF8 z?b}or>LL;>ck|R1bb>Ks@+^a3pm?%U(;9wKHKlS&T($c^JV;A^VOF+nqRH{oM*WE z)3uXerMB+w^cNFARe#Lo*RAw3j0+tKHzMU4r=4k-vo=e4?NLvtXrEz}(L-|7wXU#rvj%T0Dy>+XlXu5oroS`>cr>*2iZPG-w=oD<`__WSWutgFXy?N8CF%rbU zhW^i+Y$)SmiFjyaFF7Ta`OFjDCuuky`JyB7-=CmUWq4kCd{%QC$0B#5aAHZVi8-%D z<7wf0&(Fy_Rro7+Vo;WTitg|9#gDSHMD@1P?AwPMf%Pxg>663f&yHJzYiOk%K2R8U z@?dz*gXZVt<1a(i;vaI=Zm=aE+rU}0TNg=*=_Utq4M>Fj`cD>B z;pO`Ip>yrqL%RIXEhNunWrw;@ktURnvLLlJ3c{&eQWj0f_&99 zXXA0&^6S2YW$wv~O!v*5b8dp<<%PtsvV)FAeX5tv6fae4nbu*xwGFDEytCXad0Ddc zY|o_dq%1{uiyN-f&N~DdFY)W$z5Dk%iI&|&t^ANFPi`6-yvy{zh(oW_wa@6(s_UWn z9(S!Q$mDp~LVAVqHv`(>6t zIzhP@8=&n7rmr+&sVulW4}E4Idsj40&U1V`-KVWruLX|lcwQB3C||-h@wJ%mv|2Y} zjr#|mFYb%HGQUJA%V+GY*NzYKaoX8xu;AE?4$1LTzdLl~rY~8NLx}cVXLBG|b8#ly zxhiZY$_&aq-^4I3c5-VeubFLpBxn;lsZ(fbenGq5Ijf-dUB2413Da{_#^s&S?wb7x zD*Bwn*%0Tt{(bR>_0z)7nFO9HKWI^LRJFc{Ue;E)kJ;(=`?2o#zdHWrN?45j6{RC7 zT-~a0gjKsT+1f?S>%8x3q?4YY$aC?Kp00hZj@DGzqU?t50QS5USA=x&I5ixvhK2_! zdSSZe;JWbLcO5e0yfy46Ug+JO)3aN7^70S8`NoDNi*0a$n~x=*cyi!r&jw@1(o^RG z9eO(V>Ao;EOH{bmWSFCG_Qn!--qu4|ZAV*qe%Ub}=d~ZUc4Vs5UGJT3$2Hi%)6$&J zN?Mt`Xm1%kuUN?pv@*Y}n<4hFt?oOrXiD0yqdO$()~IQ+s($cwr_}4sU4fUs%uGozwqxAZEr48 z3{8=e!?F7{Z{>W|&N5O5FKn3A`AQ$Yg3^dKi&sp!`nd7XvR&@oJ=-2W2)9Z;_Mz19 zZr6^0&M5?u{YIuvyz|C_ZGtBijPU5fR*UDG1sZqRE2jo`SiXV^Hm6=6IJ zwL>md1&|(!@ILG8X_qSV!fCzFZ>f-VKOGb;FD3-@6I2eqnb4i#uAkNm8!%@CDBe^S ztl8_Uc2PZe=GDTv&W9E!#ot_LSu}?=Ys$&kQjBG6xzp`O=#xutw?5lpPEXo}MQ3W@ z-;#o+*1stW^b5=9EnPGFv>mCP_4+|V!qu;TsNXLAebQ-0M{x6@DeRTaH5Utwtw*k5A(G2Nn(Ju3}1kE88w&|7Ev)!s2>{+^2kHA_}}F01DE z(bKbens@rWb=M_y?p<9Nrj)XT8Q=)4517V1LijYVP&HtjZU}rw>AB`pk0{N@k^_17 zd_KIWjkR5#U9BQ_NN?jE)L0J?+~1zkh8`d|Xw(VUDbXvnYQkAaeO*6&{TvPZTbI0b z7h3liqn`1*7NjL;S3GS#K692*t;W2!58HNP-d@a`u04CvjeV09`Zf^mKQUdPI(5Q^ zTr-A&&Nbn_hPe}s&OWCpm!aQG*l(_V-7FOL9a_7tG1@Pi+ z5t9?QY`a(X$8~>J6ZTrki{H#(XkEwVsK@DW^v!u|<>l-z@NLILWdxKV1n{z|%rk-` z9Vkv%E`!I^Z-?@chbzrCDvZrt21@}B9LyKm7`?2lHUjuO8zUbg3u1-Y!y$a9Xff;= z?drviUdE;JjBM#BT9kEEXjmw6#0R261wx5+l#LM^DfwV) z$zj40u9zPt<%@)XOfH)vijdkE84cG|GTnnK<8g=eghhx216p`o5Ej6pvJwTvT4BLq z;WGI=u62+|9Lko`*B^93ttplkui?TAPj&A{mQ+ynams!C>nlrI&)KS+>?WeB9-kB+F9!DB68 z3xjQpqA)x-h#eu28qvK%_!0p5vH>ZKluO8~1t5qofd9_O?{y3q`JFj~yrVq!&7uJu zMveb(oM&6^kUIASvJ@67v9x)oAV^njhF%A|5|z#gGYD zJO&G4a1<|Oi{J>>$Sp(|HenRyk1~cz@&A*Q(X>Ny{xuIEn_z4YAQOlO@ZWm?8MJm6 zi+B-SSWIUi$Z^jN@Ub92^Bh<`URE9wmqh6NcrE z;{98k1|5$iT_od!!zusU{u{_r|Fyr71^?Gn0KiWr{|MZlaQ%eqA0hCMh<`@cPq_XO z0{@8kXLS8*aG^$uMx;MwV-$&$gkzNIe_yE&_EU!2DFn)3J5g4y{4ukG4c! z0xw#4Kv()Nxy(u_SKOpj_vc2h$%TKam=x`qeEX)nqMqEf$nk5(uw_)g@jv!fJ1wJ+)9ZbM}_28qbMpe)cZIYsE~p(O+` zS|{G<>dlI}T5gCm=YoTO<&A-XtOYjo>V52 { - let config: { - BASE_URL: string, - API_KEY: string, - CLIENT_ID: string, - USE_XDEBUG: boolean, - }; - - let headers = {}; - - beforeEach(() => { - const config_custom = require("./.config.json"); - const config_dist = require("./.config.dist.json"); - config = { ...config_dist, ...config_custom }; - - if (config["USE_XDEBUG"]) { - headers = { - "Cookie": "XDEBUG_SESSION=xdebug", - }; - } - }); - - test("testSend", () => { - const signature_request_api = new DropboxSign.SignatureRequestApi(); - signature_request_api.username = config.API_KEY; - signature_request_api.basePath = config.BASE_URL; - signature_request_api.defaultHeaders = headers; - - const data: Partial = require( - "./../test_fixtures/SignatureRequestSendRequest.json", - ); - data["files"] = [fs.createReadStream(__dirname + "/../test_fixtures/pdf-sample.pdf")]; - - const send_request = DropboxSign.SignatureRequestSendRequest.init(data); - - return signature_request_api.signatureRequestSend( - send_request, - ).then(send_response => { - const signature_request = send_response.body.signatureRequest; - - expect(send_request.formFieldsPerDocument![0].apiId) - .toBe(signature_request.customFields![0].apiId); - - expect(send_request.signers![0].emailAddress) - .toBe(signature_request.signatures![0].signerEmailAddress); - expect(send_request.signers![1].emailAddress) - .toBe(signature_request.signatures![1].signerEmailAddress); - expect(send_request.signers![2].emailAddress) - .toBe(signature_request.signatures![2].signerEmailAddress); - - return signature_request_api.signatureRequestGet( - signature_request.signatureRequestId!, - ).then(get_response => { - expect(signature_request.signatureRequestId) - .toBe(get_response.body.signatureRequest.signatureRequestId); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }); - - test("testCreateEmbedded", () => { - const signature_request_api = new DropboxSign.SignatureRequestApi(); - signature_request_api.username = config.API_KEY; - signature_request_api.basePath = config.BASE_URL; - signature_request_api.defaultHeaders = headers; - - const data: Partial = require( - "./../test_fixtures/SignatureRequestCreateEmbeddedRequest.json" - ); - data["files"] = [fs.createReadStream(__dirname + "/../test_fixtures/pdf-sample.pdf")]; - data["clientId"] = config.CLIENT_ID; - - const send_request = DropboxSign.SignatureRequestCreateEmbeddedRequest.init(data); - - return signature_request_api.signatureRequestCreateEmbedded( - send_request, - ).then(send_response => { - const signature_request = send_response.body.signatureRequest; - - expect(send_request.signers![0].emailAddress) - .toBe(signature_request.signatures![0].signerEmailAddress); - expect(send_request.signers![1].emailAddress) - .toBe(signature_request.signatures![1].signerEmailAddress); - expect(send_request.signers![2].emailAddress) - .toBe(signature_request.signatures![2].signerEmailAddress); - - const embedded_api = new DropboxSign.EmbeddedApi(); - embedded_api.username = config.API_KEY; - embedded_api.basePath = config.BASE_URL; - embedded_api.defaultHeaders = headers; - - return embedded_api.embeddedSignUrl( - signature_request.signatures![0].signatureId!, - ).then(get_response => { - expect(get_response.body.embedded.signUrl).toBeTruthy(); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }); - - test.concurrent("testSendWithoutFileError", async () => { - const config_custom = require("./.config.json"); - const config_dist = require("./.config.dist.json"); - config = { ...config_dist, ...config_custom }; - let headers = {}; - - if (config["USE_XDEBUG"]) { - headers = { - "Cookie": "XDEBUG_SESSION=xdebug", - }; - } - - const signature_request_api = new DropboxSign.SignatureRequestApi(); - signature_request_api.username = config.API_KEY; - signature_request_api.basePath = config.BASE_URL; - signature_request_api.defaultHeaders = headers; - - const data: Partial = require( - "./../test_fixtures/SignatureRequestSendRequest.json", - ); - - const request = DropboxSign.SignatureRequestSendRequest.init(data); - - return signature_request_api.signatureRequestSend(request).then(response => { - expect(response).toBeFalsy(); - }).catch((error: DropboxSign.HttpError) => { - expect(error.body.error.errorPath).toEqual("file"); - }); - }); -}); diff --git a/sandbox/node/tsconfig.json b/sandbox/node/tsconfig.json new file mode 100644 index 000000000..d7a0cd511 --- /dev/null +++ b/sandbox/node/tsconfig.json @@ -0,0 +1,32 @@ +{ + "compilerOptions": { + "module": "commonjs", + "noImplicitAny": false, + "suppressImplicitAnyIndexErrors": true, + "target": "ES6", + "allowSyntheticDefaultImports": true, + "esModuleInterop": true, + "strict": true, + "moduleResolution": "node", + "removeComments": true, + "sourceMap": true, + "noLib": false, + "declaration": true, + "emitDeclarationOnly": true, + "lib": [ + "dom", + "es6", + "es5", + "dom.iterable", + "scripthost" + ], + "typeRoots": [ + "node_modules/@types" + ], + "resolveJsonModule": true + }, + "exclude": [ + "*.tgz", + "node_modules" + ] +} diff --git a/sandbox/php/.gitignore b/sandbox/php/.gitignore new file mode 100644 index 000000000..987e2a253 --- /dev/null +++ b/sandbox/php/.gitignore @@ -0,0 +1,2 @@ +composer.lock +vendor diff --git a/sandbox/php/Example.php b/sandbox/php/Example.php deleted file mode 100644 index 39de49e79..000000000 --- a/sandbox/php/Example.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$api = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); - -try { - $result = $api->accountCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/sandbox/php/composer.json b/sandbox/php/composer.json index ab722a292..163ae9dac 100644 --- a/sandbox/php/composer.json +++ b/sandbox/php/composer.json @@ -2,7 +2,7 @@ "name": "dropbox/sign-sandbox", "autoload": { "psr-4": { - "Dropbox\\SignSandbox\\Tests\\": "test" + "Dropbox\\SignSandbox\\": "src" } }, "require": { diff --git a/sandbox/php/src/AccountCreateExample.php b/sandbox/php/src/AccountCreateExample.php new file mode 100644 index 000000000..736fb3cc6 --- /dev/null +++ b/sandbox/php/src/AccountCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountCreateOauthExample.php b/sandbox/php/src/AccountCreateOauthExample.php new file mode 100644 index 000000000..0c4898be2 --- /dev/null +++ b/sandbox/php/src/AccountCreateOauthExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com") + ->setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountGetExample.php b/sandbox/php/src/AccountGetExample.php new file mode 100644 index 000000000..96b594d7e --- /dev/null +++ b/sandbox/php/src/AccountGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountUpdateExample.php b/sandbox/php/src/AccountUpdateExample.php new file mode 100644 index 000000000..64a1ad38d --- /dev/null +++ b/sandbox/php/src/AccountUpdateExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest()) + ->setCallbackUrl("https://www.example.com/callback") + ->setLocale("en-US"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate( + account_update_request: $account_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountVerifyExample.php b/sandbox/php/src/AccountVerifyExample.php new file mode 100644 index 000000000..acdee34e7 --- /dev/null +++ b/sandbox/php/src/AccountVerifyExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest()) + ->setEmailAddress("some_user@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify( + account_verify_request: $account_verify_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppCreateExample.php b/sandbox/php/src/ApiAppCreateExample.php new file mode 100644 index 000000000..7ec68a6f5 --- /dev/null +++ b/sandbox/php/src/ApiAppCreateExample.php @@ -0,0 +1,42 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_create_request = (new Dropbox\Sign\Model\ApiAppCreateRequest()) + ->setName("My Production App") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppCreate( + api_app_create_request: $api_app_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppDeleteExample.php b/sandbox/php/src/ApiAppDeleteExample.php new file mode 100644 index 000000000..0734efaf9 --- /dev/null +++ b/sandbox/php/src/ApiAppDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppDelete( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppGetExample.php b/sandbox/php/src/ApiAppGetExample.php new file mode 100644 index 000000000..f4dcc571b --- /dev/null +++ b/sandbox/php/src/ApiAppGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppGet( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppListExample.php b/sandbox/php/src/ApiAppListExample.php new file mode 100644 index 000000000..6e9a8e5cb --- /dev/null +++ b/sandbox/php/src/ApiAppListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppUpdateExample.php b/sandbox/php/src/ApiAppUpdateExample.php new file mode 100644 index 000000000..30c22c4eb --- /dev/null +++ b/sandbox/php/src/ApiAppUpdateExample.php @@ -0,0 +1,44 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_update_request = (new Dropbox\Sign\Model\ApiAppUpdateRequest()) + ->setCallbackUrl("https://example.com/dropboxsign") + ->setName("New Name") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppUpdate( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request: $api_app_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/BulkSendJobGetExample.php b/sandbox/php/src/BulkSendJobGetExample.php new file mode 100644 index 000000000..8b74043d9 --- /dev/null +++ b/sandbox/php/src/BulkSendJobGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobGet( + bulk_send_job_id: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/BulkSendJobListExample.php b/sandbox/php/src/BulkSendJobListExample.php new file mode 100644 index 000000000..9a566d561 --- /dev/null +++ b/sandbox/php/src/BulkSendJobListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/EmbeddedEditUrlExample.php b/sandbox/php/src/EmbeddedEditUrlExample.php new file mode 100644 index 000000000..cae4929eb --- /dev/null +++ b/sandbox/php/src/EmbeddedEditUrlExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$merge_fields = [ +]; + +$embedded_edit_url_request = (new Dropbox\Sign\Model\EmbeddedEditUrlRequest()) + ->setCcRoles([ + "", + ]) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedEditUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request: $embedded_edit_url_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedEditUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/EmbeddedSignUrlExample.php b/sandbox/php/src/EmbeddedSignUrlExample.php new file mode 100644 index 000000000..b055ac6ed --- /dev/null +++ b/sandbox/php/src/EmbeddedSignUrlExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedSignUrl( + signature_id: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedSignUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/EventCallbackExample.php b/sandbox/php/src/EventCallbackExample.php new file mode 100644 index 000000000..4a21d5cbf --- /dev/null +++ b/sandbox/php/src/EventCallbackExample.php @@ -0,0 +1,35 @@ + [ + "event_type" => "account_confirmed", + "event_time" => "1669926463", + "event_hash" => "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + "event_metadata" => [ + "related_signature_id" => null, + "reported_for_account_id" => "6421d70b9bd45059fa207d03ab8d1b96515b472c", + "reported_for_app_id" => null, + "event_message" => null, + ], + ], +]; + +$callback_event = Dropbox\Sign\Model\EventCallbackRequest::init($callback_data); + +// verify that a callback came from HelloSign.com +if (Dropbox\Sign\EventCallbackHelper::isValid($api_key, $callback_event)) { + // one of "account_callback" or "api_app_callback" + $callback_type = Dropbox\Sign\EventCallbackHelper::getCallbackType($callback_event); + + // do your magic below! +} diff --git a/sandbox/php/src/FaxDeleteExample.php b/sandbox/php/src/FaxDeleteExample.php new file mode 100644 index 000000000..96ba3c0d7 --- /dev/null +++ b/sandbox/php/src/FaxDeleteExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\FaxApi(config: $config))->faxDelete( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxFilesExample.php b/sandbox/php/src/FaxFilesExample.php new file mode 100644 index 000000000..01322d769 --- /dev/null +++ b/sandbox/php/src/FaxFilesExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxFiles( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxGetExample.php b/sandbox/php/src/FaxGetExample.php new file mode 100644 index 000000000..50bb7c865 --- /dev/null +++ b/sandbox/php/src/FaxGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxGet( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineAddUserExample.php b/sandbox/php/src/FaxLineAddUserExample.php new file mode 100644 index 000000000..cca56e766 --- /dev/null +++ b/sandbox/php/src/FaxLineAddUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_add_user_request = (new Dropbox\Sign\Model\FaxLineAddUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAddUser( + fax_line_add_user_request: $fax_line_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAddUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineAreaCodeGetExample.php b/sandbox/php/src/FaxLineAreaCodeGetExample.php new file mode 100644 index 000000000..dfd46d313 --- /dev/null +++ b/sandbox/php/src/FaxLineAreaCodeGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAreaCodeGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineCreateExample.php b/sandbox/php/src/FaxLineCreateExample.php new file mode 100644 index 000000000..0a5ef5ec6 --- /dev/null +++ b/sandbox/php/src/FaxLineCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_create_request = (new Dropbox\Sign\Model\FaxLineCreateRequest()) + ->setAreaCode(209) + ->setCountry(Dropbox\Sign\Model\FaxLineCreateRequest::COUNTRY_US); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineCreate( + fax_line_create_request: $fax_line_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineDeleteExample.php b/sandbox/php/src/FaxLineDeleteExample.php new file mode 100644 index 000000000..080db2960 --- /dev/null +++ b/sandbox/php/src/FaxLineDeleteExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_delete_request = (new Dropbox\Sign\Model\FaxLineDeleteRequest()) + ->setNumber("[FAX_NUMBER]"); + +try { + (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineDelete( + fax_line_delete_request: $fax_line_delete_request, + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineGetExample.php b/sandbox/php/src/FaxLineGetExample.php new file mode 100644 index 000000000..70004942a --- /dev/null +++ b/sandbox/php/src/FaxLineGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineGet( + number: "123-123-1234", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineListExample.php b/sandbox/php/src/FaxLineListExample.php new file mode 100644 index 000000000..995c0d949 --- /dev/null +++ b/sandbox/php/src/FaxLineListExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineList( + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineRemoveUserExample.php b/sandbox/php/src/FaxLineRemoveUserExample.php new file mode 100644 index 000000000..95d117971 --- /dev/null +++ b/sandbox/php/src/FaxLineRemoveUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_remove_user_request = (new Dropbox\Sign\Model\FaxLineRemoveUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineRemoveUser( + fax_line_remove_user_request: $fax_line_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineRemoveUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxListExample.php b/sandbox/php/src/FaxListExample.php new file mode 100644 index 000000000..c0d432351 --- /dev/null +++ b/sandbox/php/src/FaxListExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxSendExample.php b/sandbox/php/src/FaxSendExample.php new file mode 100644 index 000000000..707e8ce25 --- /dev/null +++ b/sandbox/php/src/FaxSendExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); + +$fax_send_request = (new Dropbox\Sign\Model\FaxSendRequest()) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setTestMode(true) + ->setCoverPageTo("Jill Fax") + ->setCoverPageFrom("Faxer Faxerson") + ->setCoverPageMessage("I'm sending you a fax!") + ->setTitle("This is what the fax is about!") + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxSend( + fax_send_request: $fax_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxSend: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/OauthTokenGenerateExample.php b/sandbox/php/src/OauthTokenGenerateExample.php new file mode 100644 index 000000000..9b2df4a08 --- /dev/null +++ b/sandbox/php/src/OauthTokenGenerateExample.php @@ -0,0 +1,27 @@ +setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465") + ->setCode("1b0d28d90c86c141") + ->setState("900e06e2") + ->setGrantType("authorization_code"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenGenerate( + o_auth_token_generate_request: $o_auth_token_generate_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenGenerate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/OauthTokenRefreshExample.php b/sandbox/php/src/OauthTokenRefreshExample.php new file mode 100644 index 000000000..519db72d1 --- /dev/null +++ b/sandbox/php/src/OauthTokenRefreshExample.php @@ -0,0 +1,24 @@ +setGrantType("refresh_token") + ->setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenRefresh( + o_auth_token_refresh_request: $o_auth_token_refresh_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenRefresh: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ReportCreateExample.php b/sandbox/php/src/ReportCreateExample.php new file mode 100644 index 000000000..18d8d09ea --- /dev/null +++ b/sandbox/php/src/ReportCreateExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); + +$report_create_request = (new Dropbox\Sign\Model\ReportCreateRequest()) + ->setStartDate("09/01/2020") + ->setEndDate("09/01/2020") + ->setReportType([ + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, + ]); + +try { + $response = (new Dropbox\Sign\Api\ReportApi(config: $config))->reportCreate( + report_create_request: $report_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ReportApi#reportCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..1727df311 --- /dev/null +++ b/sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest()) + ->setClientId("1a659d9ad95bccd307ecad78d72192f8") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkCreateEmbeddedWithTemplate( + signature_request_bulk_create_embedded_with_template_request: $signature_request_bulk_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php b/sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php new file mode 100644 index 000000000..7574361ff --- /dev/null +++ b/sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest()) + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkSendWithTemplate( + signature_request_bulk_send_with_template_request: $signature_request_bulk_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCancelExample.php b/sandbox/php/src/SignatureRequestCancelExample.php new file mode 100644 index 000000000..969a67683 --- /dev/null +++ b/sandbox/php/src/SignatureRequestCancelExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCancel( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCancel: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php new file mode 100644 index 000000000..61d74044e --- /dev/null +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php @@ -0,0 +1,59 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..f7ea5d39a --- /dev/null +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php @@ -0,0 +1,86 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..3ff0454e8 --- /dev/null +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbeddedWithTemplate( + signature_request_create_embedded_with_template_request: $signature_request_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedExample.php new file mode 100644 index 000000000..868c62562 --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditEmbeddedExample.php @@ -0,0 +1,60 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..08ebeac0a --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php @@ -0,0 +1,87 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..640f35dfc --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php @@ -0,0 +1,50 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbeddedWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request: $signature_request_edit_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditExample.php b/sandbox/php/src/SignatureRequestEditExample.php new file mode 100644 index 000000000..92d3747c5 --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditGroupedSignersExample.php b/sandbox/php/src/SignatureRequestEditGroupedSignersExample.php new file mode 100644 index 000000000..af25d631a --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditGroupedSignersExample.php @@ -0,0 +1,96 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditWithTemplateExample.php b/sandbox/php/src/SignatureRequestEditWithTemplateExample.php new file mode 100644 index 000000000..aa8391c3e --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditWithTemplateExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_edit_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request: $signature_request_edit_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestFilesAsDataUriExample.php b/sandbox/php/src/SignatureRequestFilesAsDataUriExample.php new file mode 100644 index 000000000..0d8d71902 --- /dev/null +++ b/sandbox/php/src/SignatureRequestFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsDataUri( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php b/sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php new file mode 100644 index 000000000..feb6ac055 --- /dev/null +++ b/sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsFileUrl( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestFilesExample.php b/sandbox/php/src/SignatureRequestFilesExample.php new file mode 100644 index 000000000..b11f5ae30 --- /dev/null +++ b/sandbox/php/src/SignatureRequestFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFiles( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type: "pdf", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestGetExample.php b/sandbox/php/src/SignatureRequestGetExample.php new file mode 100644 index 000000000..dfb79eda9 --- /dev/null +++ b/sandbox/php/src/SignatureRequestGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestGet( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestListExample.php b/sandbox/php/src/SignatureRequestListExample.php new file mode 100644 index 000000000..c11043fcf --- /dev/null +++ b/sandbox/php/src/SignatureRequestListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestReleaseHoldExample.php b/sandbox/php/src/SignatureRequestReleaseHoldExample.php new file mode 100644 index 000000000..dcbbd1b31 --- /dev/null +++ b/sandbox/php/src/SignatureRequestReleaseHoldExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestReleaseHold( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestReleaseHold: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestRemindExample.php b/sandbox/php/src/SignatureRequestRemindExample.php new file mode 100644 index 000000000..10b5086a4 --- /dev/null +++ b/sandbox/php/src/SignatureRequestRemindExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_remind_request = (new Dropbox\Sign\Model\SignatureRequestRemindRequest()) + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemind( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request: $signature_request_remind_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemind: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestRemoveExample.php b/sandbox/php/src/SignatureRequestRemoveExample.php new file mode 100644 index 000000000..87ecc7e6f --- /dev/null +++ b/sandbox/php/src/SignatureRequestRemoveExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemove( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemove: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestSendExample.php b/sandbox/php/src/SignatureRequestSendExample.php new file mode 100644 index 000000000..f922a579e --- /dev/null +++ b/sandbox/php/src/SignatureRequestSendExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestSendGroupedSignersExample.php b/sandbox/php/src/SignatureRequestSendGroupedSignersExample.php new file mode 100644 index 000000000..bec0368b8 --- /dev/null +++ b/sandbox/php/src/SignatureRequestSendGroupedSignersExample.php @@ -0,0 +1,95 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestSendWithTemplateExample.php b/sandbox/php/src/SignatureRequestSendWithTemplateExample.php new file mode 100644 index 000000000..7c9963cf3 --- /dev/null +++ b/sandbox/php/src/SignatureRequestSendWithTemplateExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSendWithTemplate( + signature_request_send_with_template_request: $signature_request_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestUpdateExample.php b/sandbox/php/src/SignatureRequestUpdateExample.php new file mode 100644 index 000000000..818add598 --- /dev/null +++ b/sandbox/php/src/SignatureRequestUpdateExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_update_request = (new Dropbox\Sign\Model\SignatureRequestUpdateRequest()) + ->setSignatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f") + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestUpdate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request: $signature_request_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamAddMemberAccountIdExample.php b/sandbox/php/src/TeamAddMemberAccountIdExample.php new file mode 100644 index 000000000..f864f4437 --- /dev/null +++ b/sandbox/php/src/TeamAddMemberAccountIdExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamAddMemberExample.php b/sandbox/php/src/TeamAddMemberExample.php new file mode 100644 index 000000000..441e34dbe --- /dev/null +++ b/sandbox/php/src/TeamAddMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setEmailAddress("george@example.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamCreateExample.php b/sandbox/php/src/TeamCreateExample.php new file mode 100644 index 000000000..aabcac028 --- /dev/null +++ b/sandbox/php/src/TeamCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_create_request = (new Dropbox\Sign\Model\TeamCreateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamCreate( + team_create_request: $team_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamDeleteExample.php b/sandbox/php/src/TeamDeleteExample.php new file mode 100644 index 000000000..9c429b748 --- /dev/null +++ b/sandbox/php/src/TeamDeleteExample.php @@ -0,0 +1,18 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TeamApi(config: $config))->teamDelete(); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamGetExample.php b/sandbox/php/src/TeamGetExample.php new file mode 100644 index 000000000..79c6e054d --- /dev/null +++ b/sandbox/php/src/TeamGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamInfoExample.php b/sandbox/php/src/TeamInfoExample.php new file mode 100644 index 000000000..c908d5182 --- /dev/null +++ b/sandbox/php/src/TeamInfoExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInfo( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInfo: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamInvitesExample.php b/sandbox/php/src/TeamInvitesExample.php new file mode 100644 index 000000000..db9459376 --- /dev/null +++ b/sandbox/php/src/TeamInvitesExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInvites(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInvites: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamMembersExample.php b/sandbox/php/src/TeamMembersExample.php new file mode 100644 index 000000000..79c0343b1 --- /dev/null +++ b/sandbox/php/src/TeamMembersExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamMembers( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamMembers: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamRemoveMemberAccountIdExample.php b/sandbox/php/src/TeamRemoveMemberAccountIdExample.php new file mode 100644 index 000000000..90d902633 --- /dev/null +++ b/sandbox/php/src/TeamRemoveMemberAccountIdExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamRemoveMemberExample.php b/sandbox/php/src/TeamRemoveMemberExample.php new file mode 100644 index 000000000..3212aa335 --- /dev/null +++ b/sandbox/php/src/TeamRemoveMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setEmailAddress("teammate@dropboxsign.com") + ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamSubTeamsExample.php b/sandbox/php/src/TeamSubTeamsExample.php new file mode 100644 index 000000000..ae7a990e2 --- /dev/null +++ b/sandbox/php/src/TeamSubTeamsExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamSubTeams( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamSubTeams: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamUpdateExample.php b/sandbox/php/src/TeamUpdateExample.php new file mode 100644 index 000000000..3338af6e6 --- /dev/null +++ b/sandbox/php/src/TeamUpdateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_update_request = (new Dropbox\Sign\Model\TeamUpdateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamUpdate( + team_update_request: $team_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateAddUserExample.php b/sandbox/php/src/TemplateAddUserExample.php new file mode 100644 index 000000000..a76613a1d --- /dev/null +++ b/sandbox/php/src/TemplateAddUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_add_user_request = (new Dropbox\Sign\Model\TemplateAddUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateAddUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request: $template_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateAddUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftExample.php new file mode 100644 index 000000000..bf035f3cb --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftExample.php @@ -0,0 +1,66 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php new file mode 100644 index 000000000..120c310df --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php new file mode 100644 index 000000000..5456b67fc --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..6dc4c93c7 --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateExample.php b/sandbox/php/src/TemplateCreateExample.php new file mode 100644 index 000000000..93b6dedd0 --- /dev/null +++ b/sandbox/php/src/TemplateCreateExample.php @@ -0,0 +1,100 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateFormFieldGroupsExample.php b/sandbox/php/src/TemplateCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..1c0e02063 --- /dev/null +++ b/sandbox/php/src/TemplateCreateFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldGroups($form_field_groups) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateFormFieldRulesExample.php b/sandbox/php/src/TemplateCreateFormFieldRulesExample.php new file mode 100644 index 000000000..74009f900 --- /dev/null +++ b/sandbox/php/src/TemplateCreateFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldRules($form_field_rules) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php b/sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..a4f60e965 --- /dev/null +++ b/sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateDeleteExample.php b/sandbox/php/src/TemplateDeleteExample.php new file mode 100644 index 000000000..63c7a6a72 --- /dev/null +++ b/sandbox/php/src/TemplateDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateDelete( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateFilesAsDataUriExample.php b/sandbox/php/src/TemplateFilesAsDataUriExample.php new file mode 100644 index 000000000..df19ef818 --- /dev/null +++ b/sandbox/php/src/TemplateFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsDataUri( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateFilesAsFileUrlExample.php b/sandbox/php/src/TemplateFilesAsFileUrlExample.php new file mode 100644 index 000000000..d4fb8f53c --- /dev/null +++ b/sandbox/php/src/TemplateFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsFileUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateFilesExample.php b/sandbox/php/src/TemplateFilesExample.php new file mode 100644 index 000000000..c9d7d5307 --- /dev/null +++ b/sandbox/php/src/TemplateFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + file_type: null, + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateGetExample.php b/sandbox/php/src/TemplateGetExample.php new file mode 100644 index 000000000..3625ff5a4 --- /dev/null +++ b/sandbox/php/src/TemplateGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateGet( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateListExample.php b/sandbox/php/src/TemplateListExample.php new file mode 100644 index 000000000..536c2a630 --- /dev/null +++ b/sandbox/php/src/TemplateListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateRemoveUserExample.php b/sandbox/php/src/TemplateRemoveUserExample.php new file mode 100644 index 000000000..ecd5770f4 --- /dev/null +++ b/sandbox/php/src/TemplateRemoveUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_remove_user_request = (new Dropbox\Sign\Model\TemplateRemoveUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateRemoveUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request: $template_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateRemoveUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateUpdateFilesExample.php b/sandbox/php/src/TemplateUpdateFilesExample.php new file mode 100644 index 000000000..26470da0f --- /dev/null +++ b/sandbox/php/src/TemplateUpdateFilesExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_update_files_request = (new Dropbox\Sign\Model\TemplateUpdateFilesRequest()) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request: $template_update_files_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateUpdateFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php new file mode 100644 index 000000000..4ad74cf2c --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(true) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php new file mode 100644 index 000000000..c56719913 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php @@ -0,0 +1,76 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php new file mode 100644 index 000000000..2280c7252 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php @@ -0,0 +1,92 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..249c7eacb --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php @@ -0,0 +1,64 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..d51e60ee7 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@dropboxsign.com"); + +$ccs = [ + $ccs_1, +]; + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_embedded_with_template_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setTestMode(false) + ->setCcs($ccs) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbeddedWithTemplate( + unclaimed_draft_create_embedded_with_template_request: $unclaimed_draft_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateExample.php b/sandbox/php/src/UnclaimedDraftCreateExample.php new file mode 100644 index 000000000..8aa132af0 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateExample.php @@ -0,0 +1,38 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(true) + ->setFiles([ + ]) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php b/sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..92ec35b20 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php @@ -0,0 +1,75 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php b/sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php new file mode 100644 index 000000000..a58ad4d10 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php @@ -0,0 +1,91 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php b/sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..93e3b015a --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,63 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftEditAndResendExample.php b/sandbox/php/src/UnclaimedDraftEditAndResendExample.php new file mode 100644 index 000000000..f82ea4946 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftEditAndResendExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_edit_and_resend_request = (new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTestMode(false); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftEditAndResend( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request: $unclaimed_draft_edit_and_resend_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend: {$e->getMessage()}"; +} diff --git a/sandbox/php/test/.config.dist.json b/sandbox/php/test/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/php/test/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/php/test/.gitignore b/sandbox/php/test/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/php/test/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/php/test/SignatureRequestTest.php b/sandbox/php/test/SignatureRequestTest.php deleted file mode 100644 index 052808b36..000000000 --- a/sandbox/php/test/SignatureRequestTest.php +++ /dev/null @@ -1,151 +0,0 @@ -client_id = $config['CLIENT_ID']; - - $this->config = new Sign\Configuration(); - $this->config->setUsername($config['API_KEY']); - $this->config->setHost($config['BASE_URL']); - - if ($config['USE_XDEBUG']) { - $cookies = CookieJar::fromArray( - ['XDEBUG_SESSION' => 'xdebug'], - parse_url($config['BASE_URL'], PHP_URL_HOST), - ); - - $this->config->setOptions(['cookies' => $cookies]); - } - } - - public function testSend(): void - { - $signature_request_api = new Sign\Api\SignatureRequestApi($this->config); - - $data = json_decode( - file_get_contents(self::FIXTURES_DIR . '/SignatureRequestSendRequest.json'), - true, - ); - $file = new SplFileObject(self::FIXTURES_DIR . '/pdf-sample.pdf'); - $data['files'] = [$file]; - - $send_request = Sign\Model\SignatureRequestSendRequest::init($data); - - $send_response = $signature_request_api->signatureRequestSend($send_request); - - $this->assertEquals( - $send_request->getFormFieldsPerDocument()[0]->getApiId(), - $send_response->getSignatureRequest()->getCustomFields()[0]->getApiId(), - ); - - $this->assertEquals( - $send_request->getSigners()[0]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[0]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[1]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[1]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[2]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[2]->getSignerEmailAddress(), - ); - - $get_response = $signature_request_api->signatureRequestGet( - $send_response->getSignatureRequest()->getSignatureRequestId(), - ); - - $this->assertSame( - $send_response->getSignatureRequest()->getSignatureRequestId(), - $get_response->getSignatureRequest()->getSignatureRequestId(), - ); - } - - public function testCreateEmbedded(): void - { - $signature_request_api = new Sign\Api\SignatureRequestApi($this->config); - - $data = json_decode( - file_get_contents(self::FIXTURES_DIR . '/SignatureRequestCreateEmbeddedRequest.json'), - true, - ); - $file = new SplFileObject(self::FIXTURES_DIR . '/pdf-sample.pdf'); - $data['files'] = [$file]; - $data['client_id'] = $this->client_id; - - $send_request = Sign\Model\SignatureRequestCreateEmbeddedRequest::init($data); - - $send_response = $signature_request_api->signatureRequestCreateEmbedded($send_request); - - $this->assertEquals( - $send_request->getSigners()[0]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[0]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[1]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[1]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[2]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[2]->getSignerEmailAddress(), - ); - - $embedded_api = new Sign\Api\EmbeddedApi($this->config); - - $get_response = $embedded_api->embeddedSignUrl( - $send_response->getSignatureRequest()->getSignatures()[0]->getSignatureId(), - ); - - $this->assertNotEmpty($get_response->getEmbedded()->getSignUrl()); - } - - public function testSendWithoutFileError(): void - { - $signature_request_api = new Sign\Api\SignatureRequestApi($this->config); - - $data = json_decode( - file_get_contents(self::FIXTURES_DIR . '/SignatureRequestSendRequest.json'), - true, - ); - - $request = Sign\Model\SignatureRequestSendRequest::init($data); - - try { - $response = $signature_request_api->signatureRequestSend($request); - - $this->fail('Should have thrown: ' . print_r($response, true)); - } catch (Sign\ApiException $e) { - $error = $e->getResponseObject(); - - $this->assertEquals('file', $error->getError()->getErrorPath()); - } - } -} diff --git a/sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/php/test_fixtures/SignatureRequestSendRequest.json b/sandbox/php/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/php/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/php/test_fixtures/pdf-sample.pdf b/sandbox/php/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d41575b222e6778f87f9e9fd8da4f2b1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7945 zcmeHMdpuO@*C+SMluP1J*&zvI@43%7V>Ap=#w8@A%w=P0%rG+|l|mN^ailm(Zs}e^ zN|F@npmOP+65Wq3lG43*4?-Qk^S<})*&y`N{@p6^=E+Rxf+hC9;{gSEn= zXLQ}a+=fPx0SFLrmZE7i(1kCA*^i3}2x43QZQ_BaS{X9wZ1_EbCr zqSG8n_Eel5o1%3!bAVS5^%S&?&k<5B6^tut*VOM^A~#N5&ZSVf z2aQ7D8xk-Cq(sUVOQXba5E=!cQ8Q*ZxH+Ox-@rwqaHD)S7ES<(I=mPP=n3E{-&q(K z7|0F`{B&7Pv7My8cWs)yNn^`e%ldJ3>gs6qcJ=nQX;Ra*lqPj`zi}FvBuhDYWx47u zrC-LdQwGdX?66=do5z;20qg)+?(AS#0uTqT2LQ82<^-bPkzk>Y@Y;)nQdlUJ0N6oh zd$B0YP88)2AtXd95ugxo0U!$r5B6V1kvKv)hZN0+C87v17g3BQ3}~J&k|N;)K!ZM$ z*)*abE0aEC{1_lQ^2HJh$A^`@cbFbvkoQ z+h-cB%`nYTRh^jdI9@ez>n2r4uL}wHOeW=;ss{UMb;cfg#B?g=OxL_;mRhW=Q*Tmn zB6qvD$JG|oY=cDv6v%xLL&)zae`{TmRTtl#aR1Gnnlf|DGnP`loIfE&Nx7LdQg7Om7{`#=?4z1;0f%4eLVHE53%MHtXmvZ_xX+Dk%nvCmYVkRwh4XiMSY~wh|{ba z?qVr@(v+zaf0<~bk<)sjbrECnjnvofxvH6VQv(>ojKT!$|c?M%+5GMRQo zz?$rrrb`Z6vilmO9~Ek-J15^Pk*_aXknVhprA%)QzQ;F-RcQ*uIo)on6ofuGajBF8 z?b}or>LL;>ck|R1bb>Ks@+^a3pm?%U(;9wKHKlS&T($c^JV;A^VOF+nqRH{oM*WE z)3uXerMB+w^cNFARe#Lo*RAw3j0+tKHzMU4r=4k-vo=e4?NLvtXrEz}(L-|7wXU#rvj%T0Dy>+XlXu5oroS`>cr>*2iZPG-w=oD<`__WSWutgFXy?N8CF%rbU zhW^i+Y$)SmiFjyaFF7Ta`OFjDCuuky`JyB7-=CmUWq4kCd{%QC$0B#5aAHZVi8-%D z<7wf0&(Fy_Rro7+Vo;WTitg|9#gDSHMD@1P?AwPMf%Pxg>663f&yHJzYiOk%K2R8U z@?dz*gXZVt<1a(i;vaI=Zm=aE+rU}0TNg=*=_Utq4M>Fj`cD>B z;pO`Ip>yrqL%RIXEhNunWrw;@ktURnvLLlJ3c{&eQWj0f_&99 zXXA0&^6S2YW$wv~O!v*5b8dp<<%PtsvV)FAeX5tv6fae4nbu*xwGFDEytCXad0Ddc zY|o_dq%1{uiyN-f&N~DdFY)W$z5Dk%iI&|&t^ANFPi`6-yvy{zh(oW_wa@6(s_UWn z9(S!Q$mDp~LVAVqHv`(>6t zIzhP@8=&n7rmr+&sVulW4}E4Idsj40&U1V`-KVWruLX|lcwQB3C||-h@wJ%mv|2Y} zjr#|mFYb%HGQUJA%V+GY*NzYKaoX8xu;AE?4$1LTzdLl~rY~8NLx}cVXLBG|b8#ly zxhiZY$_&aq-^4I3c5-VeubFLpBxn;lsZ(fbenGq5Ijf-dUB2413Da{_#^s&S?wb7x zD*Bwn*%0Tt{(bR>_0z)7nFO9HKWI^LRJFc{Ue;E)kJ;(=`?2o#zdHWrN?45j6{RC7 zT-~a0gjKsT+1f?S>%8x3q?4YY$aC?Kp00hZj@DGzqU?t50QS5USA=x&I5ixvhK2_! zdSSZe;JWbLcO5e0yfy46Ug+JO)3aN7^70S8`NoDNi*0a$n~x=*cyi!r&jw@1(o^RG z9eO(V>Ao;EOH{bmWSFCG_Qn!--qu4|ZAV*qe%Ub}=d~ZUc4Vs5UGJT3$2Hi%)6$&J zN?Mt`Xm1%kuUN?pv@*Y}n<4hFt?oOrXiD0yqdO$()~IQ+s($cwr_}4sU4fUs%uGozwqxAZEr48 z3{8=e!?F7{Z{>W|&N5O5FKn3A`AQ$Yg3^dKi&sp!`nd7XvR&@oJ=-2W2)9Z;_Mz19 zZr6^0&M5?u{YIuvyz|C_ZGtBijPU5fR*UDG1sZqRE2jo`SiXV^Hm6=6IJ zwL>md1&|(!@ILG8X_qSV!fCzFZ>f-VKOGb;FD3-@6I2eqnb4i#uAkNm8!%@CDBe^S ztl8_Uc2PZe=GDTv&W9E!#ot_LSu}?=Ys$&kQjBG6xzp`O=#xutw?5lpPEXo}MQ3W@ z-;#o+*1stW^b5=9EnPGFv>mCP_4+|V!qu;TsNXLAebQ-0M{x6@DeRTaH5Utwtw*k5A(G2Nn(Ju3}1kE88w&|7Ev)!s2>{+^2kHA_}}F01DE z(bKbens@rWb=M_y?p<9Nrj)XT8Q=)4517V1LijYVP&HtjZU}rw>AB`pk0{N@k^_17 zd_KIWjkR5#U9BQ_NN?jE)L0J?+~1zkh8`d|Xw(VUDbXvnYQkAaeO*6&{TvPZTbI0b z7h3liqn`1*7NjL;S3GS#K692*t;W2!58HNP-d@a`u04CvjeV09`Zf^mKQUdPI(5Q^ zTr-A&&Nbn_hPe}s&OWCpm!aQG*l(_V-7FOL9a_7tG1@Pi+ z5t9?QY`a(X$8~>J6ZTrki{H#(XkEwVsK@DW^v!u|<>l-z@NLILWdxKV1n{z|%rk-` z9Vkv%E`!I^Z-?@chbzrCDvZrt21@}B9LyKm7`?2lHUjuO8zUbg3u1-Y!y$a9Xff;= z?drviUdE;JjBM#BT9kEEXjmw6#0R261wx5+l#LM^DfwV) z$zj40u9zPt<%@)XOfH)vijdkE84cG|GTnnK<8g=eghhx216p`o5Ej6pvJwTvT4BLq z;WGI=u62+|9Lko`*B^93ttplkui?TAPj&A{mQ+ynams!C>nlrI&)KS+>?WeB9-kB+F9!DB68 z3xjQpqA)x-h#eu28qvK%_!0p5vH>ZKluO8~1t5qofd9_O?{y3q`JFj~yrVq!&7uJu zMveb(oM&6^kUIASvJ@67v9x)oAV^njhF%A|5|z#gGYD zJO&G4a1<|Oi{J>>$Sp(|HenRyk1~cz@&A*Q(X>Ny{xuIEn_z4YAQOlO@ZWm?8MJm6 zi+B-SSWIUi$Z^jN@Ub92^Bh<`URE9wmqh6NcrE z;{98k1|5$iT_od!!zusU{u{_r|Fyr71^?Gn0KiWr{|MZlaQ%eqA0hCMh<`@cPq_XO z0{@8kXLS8*aG^$uMx;MwV-$&$gkzNIe_yE&_EU!2DFn)3J5g4y{4ukG4c! z0xw#4Kv()Nxy(u_SKOpj_vc2h$%TKam=x`qeEX)nqMqEf$nk5(uw_)g@jv!fJ1wJ+)9ZbM}_28qbMpe)cZIYsE~p(O+` zS|{G<>dlI}T5gCm=YoTO<&A-XtOYjo>V52