diff --git a/README.md b/README.md index ae8934bf7..04b157e11 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ This repo is actively maintained by Dropbox Sign's API Engineering team, but you ## Overview -Dropbox Sign's [API Reference Documentation](https://developers.hellosign.com/api/reference/overview/) is built using [openapi.yaml](openapi.yaml) and the SDKs are built using [openapi-sdk.yaml](openapi-sdk.yaml). Both of those files are **generated** as part of a build process. +Dropbox Sign's [API Reference Documentation](https://developers.hellosign.com/api/reference/overview/) is built using [openapi-fern.yaml](openapi-fern.yaml) (Fern-ready, self-contained) and the SDKs are built using [openapi-sdk.yaml](openapi-sdk.yaml). Both of those files are **generated** as part of a build process. These are the main parts of this repo you'll need to know about: - [openapi-raw.yaml](openapi-raw.yaml) -- The functional implementation of the Dropbox Sign API as an OpenAPI spec. This file reflects all public-facing work from Dropbox Sign's API Engineering team and is kept up-to-date. +- [openapi.yaml](openapi.yaml) -- Translated documentation spec with relative file references (useful when browsing this repo locally). +- [openapi-fern.yaml](openapi-fern.yaml) -- Self-contained documentation spec consumed by [sign-api-documentation](https://github.com/hellosign/sign-api-documentation) and Fern. Generated by `GenerateFernOas.php` during `./build`. - [/translations/en.yaml](translations/en.yaml) -- Contains all copy used for the API reference documentation. That includes descriptions for endpoints, parameters, schemas, and more. - [/examples/json](examples/json) -- Contains example request and response payloads for the Dropbox Sign API. - [/examples](examples) -- Contains SDK-specific example requests for each endpoint. @@ -225,6 +227,6 @@ Our source of truth is the [openapi-raw.yaml](openapi-raw.yaml) file. Everything This script replaces translation placeholders with their human values. -It generates the [openapi.yaml](openapi.yaml) file which is used for our public documentation, and generates the [openapi-sdk.yaml](openapi-sdk.yaml) file which is very similar to [openapi.yaml](openapi.yaml) but has had directives that are incompatible with the [OpenAPI Generator](https://openapi-generator.tech/) tool removed. +It generates the [openapi.yaml](openapi.yaml) file, the [openapi-fern.yaml](openapi-fern.yaml) file used by Fern documentation, and generates the [openapi-sdk.yaml](openapi-sdk.yaml) file which is very similar to [openapi.yaml](openapi.yaml) but has had directives that are incompatible with the [OpenAPI Generator](https://openapi-generator.tech/) tool removed. Any changes to our OpenAPI specification _must_ first go through [openapi-raw.yaml](openapi-raw.yaml) to ensure necessary data trickles down to the correct tools. diff --git a/bin/generate-oas.php b/bin/generate-oas.php index 81660d22d..49abf2e6c 100755 --- a/bin/generate-oas.php +++ b/bin/generate-oas.php @@ -35,3 +35,7 @@ $generate = new Hello\OpenApi\GenerateSdkOas(true); $generate->run(); } + +echo "\nCreating Fern-specific OpenAPI file ...\n"; +$generate = new Hello\OpenApi\GenerateFernOas(); +$generate->run(); diff --git a/examples/json/SignatureRequestFilesResponse.json b/examples/json/SignatureRequestFilesResponse.json index 276c1595c..2ac093137 100644 --- a/examples/json/SignatureRequestFilesResponse.json +++ b/examples/json/SignatureRequestFilesResponse.json @@ -1,4 +1,4 @@ { - "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=AKIAJWEWDFQHQMBECJZA&Expires=1452868903&Signature=M%2FNDS%2BQre8xjPvzm7fHf%2BjO8Zbc%3D", + "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=EXAMPLE_ACCESS_KEY_ID&Expires=1452868903&Signature=EXAMPLE_SIGNATURE", "expires_at": 1458605123 } diff --git a/examples/json/TemplateFilesResponse.json b/examples/json/TemplateFilesResponse.json index 276c1595c..2ac093137 100644 --- a/examples/json/TemplateFilesResponse.json +++ b/examples/json/TemplateFilesResponse.json @@ -1,4 +1,4 @@ { - "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=AKIAJWEWDFQHQMBECJZA&Expires=1452868903&Signature=M%2FNDS%2BQre8xjPvzm7fHf%2BjO8Zbc%3D", + "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=EXAMPLE_ACCESS_KEY_ID&Expires=1452868903&Signature=EXAMPLE_SIGNATURE", "expires_at": 1458605123 } diff --git a/openapi-fern.yaml b/openapi-fern.yaml new file mode 100644 index 000000000..68f3949f8 --- /dev/null +++ b/openapi-fern.yaml @@ -0,0 +1,34675 @@ +openapi: 3.0.3 +info: + title: Dropbox Sign API + description: Dropbox Sign v3 API + termsOfService: https://sign.dropbox.com/terms + contact: + email: apisupport@hellosign.com + license: + name: MIT + url: https://opensource.org/licenses/MIT + version: 3.0.0 +servers: + - url: https://api.hellosign.com/v3 +security: + - api_key: [] + - oauth2: + - account_access + - signature_request_access + - template_access + - team_access + - api_app_access + - basic_account_info + - request_signature +tags: + - name: Account + description: Contains information about an account and its settings + - name: Signature Request + description: Contains information regarding documents that need to be signed + - name: Template + description: Contains information about the templates you and your team have created + - name: Bulk Send Job + description: Contains information about bulk sent signature requests + - name: Report + description: Provides insights into your team's user activity and document status + - name: Team + description: Contains information about your team and its members + - name: Unclaimed Draft + description: A group of documents that a user can take ownership of via the claim URL + - name: Embedded + description: An object that contains necessary information to set up embedded signing + - name: Api App + description: Contains information about an API App + - name: OAuth + description: |- + OAuth allows you to perform actions on behalf of other users after they grant you the authorization to do so. For example, you could send signature requests on behalf of your users. + + We recommend using our [OAuth Walkthrough](https://app.hellosign.com/api/oauthWalkthrough) for more detailed instructions. + + OAuth apps can either be set up to charge you, the **app owner**, or the **user you are acting on behalf of**. This choice is determined by which scopes you select for your app. + + ### OAuth scopes where app owner is charged + | Name | Value | Description | + |--|--|--| + | Basic Account Info (limited) | `basic_account_info` | Access basic account information, such as email address and name. | + | Send Signature Requests (limited) | `request_signature` | Send signature requests, access statuses and document files. | + + ### OAuth scopes where users are charged + | Name | Value | Description | + |--|--|--| + | Account Access | `account_access` | Access to basic account information, such as email address and name. | + | Signature Request Access | `signature_request_access` | Access to send, view, and update signature requests and to download document files. Signature requests must be made with oAuth token in order to access. | + | Template Access | `template_access` | Access to view, create, and modify templates. | + | Team Access | `team_access` | Access to view and modify team settings and team members. | + | API App Access | `api_app_access` | Access to view, create, and modify embedded API apps. | + - name: Callbacks and Events + description: |- + Events will be POSTed to your callback URLs. There are two kinds of callbacks that can be defined. + + **Callback Response Format** + + The default format for messages sent to your callbacks is a multipart ('form/multipart') POST request, with the message details in a POST field named 'json'. + + The Java SDK includes an event parsing class, and you can access this field in the $_POST array on PHP. For other platforms, either a library function, such as cgi.parse_multipart (for python) or ActionDispatch::Http::UploadedFile for Rails, or third party options, such as multer for node, may be useful. + - name: Fax Line + description: Contains information about the fax lines you and your team have created +externalDocs: + description: Legacy API Reference + url: https://app.hellosign.com/api/reference +paths: + /account/create: + post: + tags: + - Account + summary: Create Account + description: Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + operationId: accountCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccountCreateRequest' + examples: + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' + 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/AccountCreateResponse' + examples: + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - account_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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", + ) + + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/account/create' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=newuser@dropboxsign.com' + x-meta: + seo: + title: Create Account | API Documentation | Dropbox Sign for Developers + description: The Dropbox Sign API allows you to build with a range of tools. Find out how to create a new Dropbox Sign Account using the specified `email_address` here. + /account: + get: + tags: + - Account + summary: Get Account + description: Returns the properties and settings of your Account. + operationId: accountGet + parameters: + - name: account_id + in: query + description: |- + `account_id` or `email_address` is required. If both are provided, the account id prevails. + + The ID of the Account. + required: false + schema: + type: string + - name: email_address + in: query + description: |- + `account_id` or `email_address` is required, If both are provided, the account id prevails. + + The email address of the Account. + required: false + schema: + type: string + 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/AccountGetResponse' + examples: + example: + $ref: '#/components/examples/AccountGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - account_access + - basic_account_info + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet( + null, // accountId + null // emailAddress + ); + + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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.AccountApi(api_client).account_get() + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_get: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/account?email_address=jack@example.com' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Get Account | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return the properties and settings of your Account, click here.' + put: + tags: + - Account + summary: Update Account + description: Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + operationId: accountUpdate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccountUpdateRequest' + examples: + example: + $ref: '#/components/examples/AccountUpdateRequest' + 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/AccountGetResponse' + examples: + example: + $ref: '#/components/examples/AccountUpdateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - account_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.AccountUpdateRequest = { + callbackUrl: "https://www.example.com/callback", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_update_request = models.AccountUpdateRequest( + callback_url="https://www.example.com/callback", + locale="en-US", + ) + + try: + response = api.AccountApi(api_client).account_update( + account_update_request=account_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_update: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X PUT 'https://api.hellosign.com/v3/account' \ + -u 'YOUR_API_KEY:' \ + -F 'callback_url=https://www.example.com/callback' \ + -F 'locale=en-US' + x-meta: + seo: + title: Update Account | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how update the properties and settings of your Account, click here.' + /account/verify: + post: + tags: + - Account + summary: Verify Account + description: Verifies whether an Dropbox Sign Account exists for the given email address. + operationId: accountVerify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccountVerifyRequest' + examples: + example: + $ref: '#/components/examples/AccountVerifyRequest' + 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/AccountVerifyResponse' + examples: + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - account_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_verify_request = models.AccountVerifyRequest( + email_address="some_user@dropboxsign.com", + ) + + try: + response = api.AccountApi(api_client).account_verify( + account_verify_request=account_verify_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_verify: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/account/verify' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=some_user@dropboxsign.com' + x-meta: + seo: + title: Verify Account | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to verify whether an Account exists, click here.' + /api_app: + post: + tags: + - Api App + summary: Create API App + description: Creates a new API App. + operationId: apiAppCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApiAppCreateRequest' + examples: + example: + $ref: '#/components/examples/ApiAppCreateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ApiAppCreateRequest' + responses: + '201': + 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/ApiAppGetResponse' + examples: + example: + $ref: '#/components/examples/ApiAppCreateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - api_app_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubOAuth = { + callbackUrl: "https://example.com/oauth", + scopes: [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, + ], + }; + + const whiteLabelingOptions: models.SubWhiteLabelingOptions = { + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff", + }; + + const apiAppCreateRequest: models.ApiAppCreateRequest = { + name: "My Production App", + domains: [ + "example.com", + ], + customLogoFile: fs.createReadStream("CustomLogoFile.png"), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions, + }; + + apiCaller.apiAppCreate( + apiAppCreateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppCreate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_create_request = models.ApiAppCreateRequest( + name="My Production App", + 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_create( + api_app_create_request=api_app_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_create: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/api_app' \ + -u 'YOUR_API_KEY:' \ + -F 'name=My Production App' \ + -F 'domains[]=example.com' \ + -F 'oauth[callback_url]=https://example.com/oauth' \ + -F 'oauth[scopes][]=basic_account_info' \ + -F 'oauth[scopes][]=request_signature' \ + -F 'white_labeling_options[primary_button_color]=#00b3e6' \ + -F 'white_labeling_options[primary_button_text_color]=#ffffff' + x-meta: + seo: + title: Create API App | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to create a new API App, click here.' + /api_app/{client_id}: + get: + tags: + - Api App + summary: Get API App + description: Returns an object with information about an API App. + operationId: apiAppGet + parameters: + - name: client_id + in: path + description: The client id of the API App to retrieve. + required: true + schema: + type: string + example: 0dd3b823a682527788c4e40cb7b6f7e9 + 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/ApiAppGetResponse' + examples: + example: + $ref: '#/components/examples/ApiAppGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - api_app_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_get( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_get: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/api_app/{client_id}' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Get API App | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return an object with information about an API App, click here.' + put: + tags: + - Api App + summary: Update API App + description: 'Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.' + operationId: apiAppUpdate + parameters: + - name: client_id + in: path + description: The client id of the API App to update. + required: true + schema: + type: string + example: 0dd3b823a682527788c4e40cb7b6f7e9 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApiAppUpdateRequest' + examples: + example: + $ref: '#/components/examples/ApiAppUpdateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ApiAppUpdateRequest' + 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/ApiAppGetResponse' + examples: + example: + $ref: '#/components/examples/ApiAppUpdateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - api_app_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubOAuth = { + callbackUrl: "https://example.com/oauth", + scopes: [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, + ], + }; + + const whiteLabelingOptions: models.SubWhiteLabelingOptions = { + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff", + }; + + const apiAppUpdateRequest: models.ApiAppUpdateRequest = { + callbackUrl: "https://example.com/dropboxsign", + name: "New Name", + domains: [ + "example.com", + ], + customLogoFile: fs.createReadStream("CustomLogoFile.png"), + oauth: oauth, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X PUT 'https://api.hellosign.com/v3/api_app/{client_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'name=New Name' \ + -F 'callback_url=https://example.com/dropboxsign' \ + -F 'white_labeling_options[primary_button_color]=#00b3e6' \ + -F 'white_labeling_options[primary_button_text_color]=#ffffff' + x-meta: + seo: + title: Update API App | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to update an App that you own, click here.' + delete: + tags: + - Api App + summary: Delete API App + description: Deletes an API App. Can only be invoked for apps you own. + operationId: apiAppDelete + parameters: + - name: client_id + in: path + description: The client id of the API App to delete. + required: true + schema: + type: string + example: 0dd3b823a682527788c4e40cb7b6f7e9 + responses: + '204': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - api_app_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X DELETE 'https://api.hellosign.com/v3/api_app/{client_id}' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Delete API App | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to delete an API App, click here.' + /api_app/list: + get: + tags: + - Api App + summary: List API Apps + description: 'Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.' + operationId: apiAppList + parameters: + - name: page + in: query + description: Which page number of the API App 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 + 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/ApiAppListResponse' + examples: + example: + $ref: '#/components/examples/ApiAppListResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - api_app_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/api_app/list?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: List API Apps | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return a list of API Apps that are accessible by you, click here.' + /bulk_send_job/{bulk_send_job_id}: + get: + tags: + - Bulk Send Job + summary: Get Bulk Send Job + description: Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + operationId: bulkSendJobGet + parameters: + - name: bulk_send_job_id + in: path + description: The id of the BulkSendJob to retrieve. + required: true + schema: + type: string + example: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174 + - name: page + in: query + description: Which page number of the BulkSendJob 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 + 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/BulkSendJobGetResponse' + examples: + example: + $ref: '#/components/examples/BulkSendJobGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/bulk_send_job/{bulk_send_job_id}' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Get Bulk Send Job | API 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 the BulkSendJob and SignatureRequests, click here.' + /bulk_send_job/list: + get: + tags: + - Bulk Send Job + summary: List Bulk Send Jobs + description: Returns a list of BulkSendJob that you can access. + operationId: bulkSendJobList + parameters: + - name: page + in: query + description: Which page number of the BulkSendJob 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 + 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/BulkSendJobListResponse' + examples: + example: + $ref: '#/components/examples/BulkSendJobListResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/bulk_send_job/list?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: List Bulk Send Jobs | Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here.' + /embedded/edit_url/{template_id}: + post: + tags: + - Embedded + summary: Get Embedded Template Edit URL + description: Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + operationId: embeddedEditUrl + parameters: + - name: template_id + in: path + description: The id of the template to edit. + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EmbeddedEditUrlRequest' + examples: + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' + 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/EmbeddedEditUrlResponse' + examples: + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.EmbeddedEditUrlRequest = { + ccRoles: [ + "", + ], + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/embedded/edit_url/{template_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'cc_roles[0]=' \ + -F 'merge_fields=[]' + x-meta: + seo: + title: Get Embedded Template URL | iFrame | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here.' + /embedded/sign_url/{signature_id}: + get: + tags: + - Embedded + summary: Get Embedded Sign URL + description: Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + operationId: embeddedSignUrl + parameters: + - name: signature_id + in: path + description: The id of the signature to get a signature url for. + required: true + schema: + type: string + example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b + 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/EmbeddedSignUrlResponse' + examples: + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/embedded/sign_url/{signature_id}' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Get Embedded Sign URL | iFrame | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' + /fax/{fax_id}: + get: + tags: + - Fax + summary: Get Fax + description: Returns information about a Fax + operationId: faxGet + parameters: + - name: fax_id + in: path + description: Fax ID + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + example: + $ref: '#/components/examples/FaxGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxApi#fax_get: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/fax/{fax_id}' \ + -u 'YOUR_API_KEY:' + 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 properties of a fax, click here.' + delete: + tags: + - Fax + summary: Delete Fax + description: Deletes the specified Fax from the system + operationId: faxDelete + parameters: + - name: fax_id + in: path + description: Fax ID + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '204': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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 FaxDeleteExample + { + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + new FaxApi(config).FaxDelete( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X DELETE 'https://api.hellosign.com/v3/fax/{fax_id}' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Delete Fax | API Documentation | Dropbox Fax for Developers + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.' + /fax/files/{fax_id}: + get: + tags: + - Fax + summary: Download Fax Files + description: Downloads files associated with a Fax + operationId: faxFiles + parameters: + - name: fax_id + in: path + description: Fax ID + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: |- + curl -X GET 'https://api.hellosign.com/v3/fax/files/{fax_id}' \ + -u 'YOUR_API_KEY:' \ + --output downloaded_document.pdf + 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 the files of a fax, click here.' + /fax_line/add_user: + put: + tags: + - Fax Line + summary: Add Fax Line User + description: Grants a user access to the specified Fax Line. + operationId: faxLineAddUser + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineAddUserRequest' + examples: + example: + $ref: '#/components/examples/FaxLineAddUserRequest' + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineResponse' + examples: + example: + $ref: '#/components/examples/FaxLineResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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 FaxLineAddUserExample + { + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineAddUserRequest = new FaxLineAddUserRequest( + number: "[FAX_NUMBER]", + emailAddress: "member@dropboxsign.com" + ); + + try + { + var response = new FaxLineApi(config).FaxLineAddUser( + faxLineAddUserRequest: faxLineAddUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAddUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.FaxLineAddUserRequest = { + number: "[FAX_NUMBER]", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_add_user_request = models.FaxLineAddUserRequest( + number="[FAX_NUMBER]", + email_address="member@dropboxsign.com", + ) + + try: + 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 FaxLineApi#fax_line_add_user: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/fax_line/add_user' \ + -u 'YOUR_API_KEY:' \ + -F 'number=[FAX_NUMBER]' \ + -F 'email_address=member@dropboxsign.com' + x-meta: + seo: + title: Fax Line Add User | API Documentation | Dropbox Fax for Developers + 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.' + /fax_line/area_codes: + get: + tags: + - Fax Line + summary: Get Available Fax Line Area Codes + 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 + required: true + schema: + type: string + enum: + - CA + - US + - UK + example: US + - name: state + in: query + description: Filter area codes by state + schema: + type: string + 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 + - name: province + in: query + description: Filter area codes by province + schema: + type: string + enum: + - AB + - BC + - MB + - NB + - NL + - NT + - NS + - NU + - 'ON' + - PE + - QC + - SK + - YT + - name: city + in: query + description: Filter area codes by city + schema: + type: string + 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/FaxLineAreaCodeGetResponse' + examples: + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + setUsername("YOUR_API_KEY"); + + try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAreaCodeGet( + country: "US", + ); + + print_r($response); + } catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAreaCodeGet: {$e->getMessage()}"; + } + - lang: csharp + label: C# + source: | + 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" + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/fax_line/area_codes' \ + -u 'YOUR_API_KEY:' \ + -F 'country=US' \ + -F 'state=CA' + 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 what area codes are available, click here.' + /fax_line/create: + post: + tags: + - Fax Line + summary: Purchase Fax Line + description: Purchases a new Fax Line + operationId: faxLineCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineCreateRequest' + examples: + example: + $ref: '#/components/examples/FaxLineCreateRequest' + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineResponse' + examples: + example: + $ref: '#/components/examples/FaxLineResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.FaxLineCreateRequest = { + areaCode: 209, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/fax_line/create' \ + -u 'YOUR_API_KEY:' \ + -F 'area_code=209' \ + -F 'country=US' + x-meta: + seo: + title: Purchase Fax Line | 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.' + /fax_line: + get: + tags: + - Fax Line + summary: Get Fax Line + description: Returns the properties and settings of a Fax Line. + operationId: faxLineGet + parameters: + - name: number + in: query + description: The Fax Line number + required: true + schema: + type: string + example: 123-123-1234 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineResponse' + examples: + example: + $ref: '#/components/examples/FaxLineResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/fax_line?number=[FAX_NUMBER]' \ + -u 'YOUR_API_KEY:' + 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 the properties of a fax line, click here.' + delete: + tags: + - Fax Line + summary: Delete Fax Line + description: Deletes the specified Fax Line from the subscription. + operationId: faxLineDelete + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineDeleteRequest' + examples: + example: + $ref: '#/components/examples/FaxLineDeleteRequest' + 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: {} + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.FaxLineDeleteRequest = { + number: "[FAX_NUMBER]", + }; + + apiCaller.faxLineDelete( + faxLineDeleteRequest, + ).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineDelete:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X DELETE 'https://api.hellosign.com/v3/fax_line' \ + -u 'YOUR_API_KEY:' \ + -F 'number=[FAX_NUMBER]' + x-meta: + seo: + title: Delete Fax Line | API Documentation | Dropbox Fax for Developers + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.' + /fax_line/list: + get: + tags: + - Fax Line + summary: List Fax Lines + description: Returns the properties and settings of multiple Fax Lines. + operationId: faxLineList + parameters: + - name: account_id + in: query + description: Account ID + schema: + type: string + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + - name: page + in: query + description: Which page number of the Fax Line 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 + example: 20 + - name: show_team_lines + in: query + description: Include Fax Lines belonging to team members in the list + schema: + type: boolean + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineListResponse' + examples: + example: + $ref: '#/components/examples/FaxLineListResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + setUsername("YOUR_API_KEY"); + + try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineList( + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + ); + + print_r($response); + } catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineList: {$e->getMessage()}"; + } + - lang: csharp + label: C# + source: | + 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 + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/fax_line/list' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: List Fax Lines | API Documentation | Dropbox Fax for Developers + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.' + /fax_line/remove_user: + put: + tags: + - Fax Line + summary: Remove Fax Line Access + description: Removes a user's access to the specified Fax Line + operationId: faxLineRemoveUser + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineRemoveUserRequest' + examples: + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxLineResponse' + examples: + example: + $ref: '#/components/examples/FaxLineResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.FaxLineRemoveUserRequest = { + number: "[FAX_NUMBER]", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/fax_line/remove_user' \ + -u 'YOUR_API_KEY:' \ + -F 'number=[FAX_NUMBER]' \ + -F 'email_address=member@dropboxsign.com' + x-meta: + seo: + title: Fax Line Remove User | API Documentation | Dropbox Fax for Developers + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + /fax/list: + get: + tags: + - Fax + summary: Lists Faxes + description: Returns properties of multiple Faxes + operationId: faxList + parameters: + - name: page + in: query + description: Which page number of the Fax List to return. Defaults to `1`. + schema: + type: integer + default: 1 + minimum: 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 + maximum: 100 + minimum: 1 + example: 20 + 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/FaxListResponse' + examples: + example: + $ref: '#/components/examples/FaxListResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxApi#fax_list: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/fax/list?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: List Faxes | API Documentation | Dropbox Fax for Developers + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.' + /fax/send: + post: + tags: + - Fax + summary: Send Fax + description: Creates and sends a new Fax with the submitted file(s) + operationId: faxSend + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxSendRequest' + examples: + example: + $ref: '#/components/examples/FaxSendRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/FaxSendRequest' + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + example: + $ref: '#/components/examples/FaxGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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: [ + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_send_request = models.FaxSendRequest( + recipient="16690000001", + sender="16690000000", + test_mode=True, + cover_page_to="Jill 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 = api.FaxApi(api_client).fax_send( + fax_send_request=fax_send_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxApi#fax_send: %s\n" % e) + - lang: cURL + label: cURL + source: |- + curl -X POST 'https://api.hellosign.com/v3/fax/send' \ + -u 'YOUR_API_KEY:' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'test_mode=1' \ + -F 'recipient=16690000001' \ + -F 'sender=16690000000' \ + -F 'cover_page_to=Jill Fax' \ + -F 'cover_page_message=I sent you a fax!' \ + -F 'cover_page_from=Faxer Faxerson' \ + -F 'title=This is what the fax is about!' + x-meta: + seo: + title: Send Fax | API Documentation | Dropbox Fax for Developers + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' + /oauth/token: + post: + tags: + - OAuth + summary: OAuth Token Generate + description: 'Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.' + operationId: oauthTokenGenerate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OAuthTokenGenerateRequest' + examples: + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' + 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/OAuthTokenResponse' + examples: + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: [] + servers: + - url: https://app.hellosign.com + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + import * as fs from 'fs'; + import api from "@dropbox/sign" + import models from "@dropbox/sign" + + const apiCaller = new api.OAuthApi(); + + const oAuthTokenGenerateRequest: models.OAuthTokenGenerateRequest = { + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465", + code: "1b0d28d90c86c141", + state: "900e06e2", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://app.hellosign.com/oauth/token' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'state=900e06e2' \ + -F 'code=1b0d28d90c86c141' \ + -F 'grant_type=authorization_code' \ + -F 'client_secret=1d14434088507ffa390e6f5528465' + x-meta: + seo: + title: Generate OAuth Token | Documentation | Dropbox Sign for Developers + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here.' + x-hideTryItPanel: true + /oauth/token?refresh: + post: + tags: + - OAuth + summary: OAuth Token Refresh + description: Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + operationId: oauthTokenRefresh + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OAuthTokenRefreshRequest' + examples: + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' + 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/OAuthTokenResponse' + examples: + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: [] + servers: + - url: https://app.hellosign.com + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + import * as fs from 'fs'; + import api from "@dropbox/sign" + import models from "@dropbox/sign" + + const apiCaller = new api.OAuthApi(); + + const oAuthTokenRefreshRequest: models.OAuthTokenRefreshRequest = { + grantType: "refresh_token", + refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", + }; + + apiCaller.oauthTokenRefresh( + oAuthTokenRefreshRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenRefresh:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://app.hellosign.com/oauth/token?refresh' \ + -F 'grant_type=refresh_token' \ + -F 'refresh_token=hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3' + x-meta: + seo: + title: OAuth Token Refresh | Documentation | Dropbox Sign for Developers + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here.' + x-hideTryItPanel: true + /report/create: + post: + tags: + - Report + summary: Create Report + description: |- + Request the creation of one or more report(s). + + When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + operationId: reportCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReportCreateRequest' + examples: + example: + $ref: '#/components/examples/ReportCreateRequest' + 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/ReportCreateResponse' + examples: + example: + $ref: '#/components/examples/ReportCreateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.ReportCreateRequest = { + startDate: "09/01/2020", + endDate: "09/01/2020", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/report/create' \ + -u 'YOUR_API_KEY:' \ + -F 'start_date=09/01/2020' \ + -F 'end_date=09/01/2020' \ + -F 'report_type[]=user_activity' \ + -F 'report_type[]=document_status' + x-meta: + seo: + title: Create Report | 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 request the creation of one or more reports, click here.' + /signature_request/bulk_create_embedded_with_template: + post: + tags: + - Signature Request + summary: Embedded Bulk Send with Template + description: |- + Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + + **NOTE:** Only available for Standard plan and higher. + operationId: signatureRequestBulkCreateEmbeddedWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' + 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/BulkSendJobSendResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubBulkSignerListCustomField = { + name: "company", + value: "123 LLC", + }; + + const signerList2CustomFields = [ + signerList2CustomFields1, + ]; + + const signerList2Signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b", + }; + + const signerList2Signers = [ + signerList2Signers1, + ]; + + const signerList1CustomFields1: models.SubBulkSignerListCustomField = { + name: "company", + value: "ABC Corp", + }; + + const signerList1CustomFields = [ + signerList1CustomFields1, + ]; + + const signerList1Signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td", + }; + + const signerList1Signers = [ + signerList1Signers1, + ]; + + const signerList1: models.SubBulkSignerList = { + customFields: signerList1CustomFields, + signers: signerList1Signers, + }; + + const signerList2: models.SubBulkSignerList = { + customFields: signerList2CustomFields, + signers: signerList2Signers, + }; + + const signerList = [ + signerList1, + signerList2, + ]; + + const ccs1: models.SubCC = { + role: "Accounting", + emailAddress: "accounting@example.com", + }; + + const ccs = [ + ccs1, + ]; + + const signatureRequestBulkCreateEmbeddedWithTemplateRequest: models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest = { + clientId: "1a659d9ad95bccd307ecad78d72192f8", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs, + }; + + apiCaller.signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/bulk_create_embedded_with_template' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'template_ids[]=c26b8a16784a872da37ea946b9ddec7c1e11dff6' \ + -F 'subject=Purchase Order' \ + -F 'message=Glad we could come to an agreement.' \ + -F 'signer_list[0][signers][role]=Client' \ + -F 'signer_list[0][signers][name]=George' \ + -F 'signer_list[0][signers][email_address]=george@example.com' \ + -F 'signer_list[0][signers][pin]=d79a3td' \ + -F 'signer_list[0][custom_fields][0][name]=company' \ + -F 'signer_list[0][custom_fields][0][value]=ABC Corp' \ + -F 'signer_list[1][signers][role]=Client' \ + -F 'signer_list[1][signers][name]=Mary' \ + -F 'signer_list[1][signers][email_address]=mary@example.com' \ + -F 'signer_list[1][signers][pin]=gd9as5b' \ + -F 'signer_list[1][custom_fields][0][name]=company' \ + -F 'signer_list[1][custom_fields][0][value]=123 LLC' \ + -F 'ccs[0][role]=Accounting' \ + -F 'ccs[0][email_address]=accounting@example.com' \ + -F 'test_mode=1' + x-meta: + seo: + title: Embedded Bulk Send with Template | Dropbox Sign for Developers + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here.' + /signature_request/bulk_send_with_template: + post: + tags: + - Signature Request + summary: Bulk Send with Template + description: |- + Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. + + **NOTE:** Only available for Standard plan and higher. + operationId: signatureRequestBulkSendWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' + 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/BulkSendJobSendResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubBulkSignerListCustomField = { + name: "company", + value: "123 LLC", + }; + + const signerList2CustomFields = [ + signerList2CustomFields1, + ]; + + const signerList2Signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b", + }; + + const signerList2Signers = [ + signerList2Signers1, + ]; + + const signerList1CustomFields1: models.SubBulkSignerListCustomField = { + name: "company", + value: "ABC Corp", + }; + + const signerList1CustomFields = [ + signerList1CustomFields1, + ]; + + const signerList1Signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td", + }; + + const signerList1Signers = [ + signerList1Signers1, + ]; + + const signerList1: models.SubBulkSignerList = { + customFields: signerList1CustomFields, + signers: signerList1Signers, + }; + + const signerList2: models.SubBulkSignerList = { + customFields: signerList2CustomFields, + signers: signerList2Signers, + }; + + const signerList = [ + signerList1, + signerList2, + ]; + + const ccs1: models.SubCC = { + role: "Accounting", + emailAddress: "accounting@example.com", + }; + + const ccs = [ + ccs1, + ]; + + const signatureRequestBulkSendWithTemplateRequest: models.SignatureRequestBulkSendWithTemplateRequest = { + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs, + }; + + apiCaller.signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/bulk_send_with_template' \ + -u 'YOUR_API_KEY:' \ + -F 'template_ids[]=c26b8a16784a872da37ea946b9ddec7c1e11dff6' \ + -F 'subject=Purchase Order' \ + -F 'message=Glad we could come to an agreement.' \ + -F 'signer_list[0][signers][role]=Client' \ + -F 'signer_list[0][signers][name]=George' \ + -F 'signer_list[0][signers][email_address]=george@example.com' \ + -F 'signer_list[0][signers][pin]=d79a3td' \ + -F 'signer_list[0][custom_fields][0][name]=company' \ + -F 'signer_list[0][custom_fields][0][value]=ABC Corp' \ + -F 'signer_list[1][signers][role]=Client' \ + -F 'signer_list[1][signers][name]=Mary' \ + -F 'signer_list[1][signers][email_address]=mary@example.com' \ + -F 'signer_list[1][signers][pin]=gd9as5b' \ + -F 'signer_list[1][custom_fields][0][name]=company' \ + -F 'signer_list[1][custom_fields][0][value]=123 LLC' \ + -F 'ccs[0][role]=Accounting' \ + -F 'ccs[0][email_address]=accounting@example.com' \ + -F 'test_mode=1' + x-meta: + seo: + title: Bulk Send with Template | REST API | Dropbox Sign for Developers + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here.' + /signature_request/cancel/{signature_request_id}: + post: + tags: + - Signature Request + summary: Cancel Incomplete Signature Request + description: |- + Cancels an incomplete signature request. This action is **not reversible**. + + The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. + + This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. + + To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. + + **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + operationId: signatureRequestCancel + parameters: + - name: signature_request_id + in: path + description: The id of the incomplete SignatureRequest to cancel. + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: {} + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/cancel/{signature_request_id}' \ + -u 'YOUR_API_KEY:' + x-meta: + seo: + title: Cancel Incomplete Signature Request | Dropbox Sign for Developers + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here.' + /signature_request/create_embedded: + post: + tags: + - Signature Request + summary: Create Embedded Signature Request + description: 'Creates a new 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: signatureRequestCreateEmbedded + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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) + ->setForceAdvancedSignatureDetails(false); + + $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()}"; + } + - lang: csharp + label: C# + source: | + 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, + force_advanced_signature_details: false + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + force_advanced_signature_details: false, + }; + + const signers1: models.SubSignatureRequestSigner = { + name: "Jack", + emailAddress: "jack@example.com", + order: 0, + }; + + const signers2: models.SubSignatureRequestSigner = { + name: "Jill", + emailAddress: "jill@example.com", + order: 1, + }; + + const signers = [ + signers1, + signers2, + ]; + + const signatureRequestCreateEmbeddedRequest: models.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: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + signingOptions: signingOptions, + signers: signers, + }; + + apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); + + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + signing_options.force_advanced_signature_details = false + + 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 + - lang: Python + label: Python + source: | + 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, + force_advanced_signature_details=False, + ) + + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/create_embedded' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'title=NDA with Acme Co.' \ + -F 'subject=The NDA we talked about' \ + -F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \ + -F 'signers[0][email_address]=jack@example.com' \ + -F 'signers[0][name]=Jack' \ + -F 'signers[0][order]=0' \ + -F 'signers[1][email_address]=jill@example.com' \ + -F 'signers[1][name]=Jill' \ + -F 'signers[1][order]=1' \ + -F 'cc_email_addresses[]=lawyer1@dropboxsign.com' \ + -F 'cc_email_addresses[]=lawyer2@dropboxsign.com' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ + -F 'test_mode=1' + x-meta: + seo: + title: Create 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 create a new SignatureRequest in an iFrame, click here.' + /signature_request/create_embedded_with_template: + post: + tags: + - Signature Request + summary: Create Embedded Signature Request with Template + description: Creates a new 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: signatureRequestCreateEmbeddedWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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) + ->setForceAdvancedSignatureDetails(false); + + $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()}"; + } + - lang: csharp + label: C# + source: | + 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, + force_advanced_signature_details: false + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + force_advanced_signature_details: false, + }; + + const signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + }; + + const signers = [ + signers1, + ]; + + const signatureRequestCreateEmbeddedWithTemplateRequest: models.SignatureRequestCreateEmbeddedWithTemplateRequest = { + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + }; + + apiCaller.signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); + + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + signing_options.force_advanced_signature_details = false + + 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 + - lang: Python + label: Python + source: | + 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, + force_advanced_signature_details=False, + ) + + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/create_embedded_with_template' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'template_ids[]=c26b8a16784a872da37ea946b9ddec7c1e11dff6' \ + -F 'subject=Purchase Order' \ + -F 'message=Glad we could come to an agreement.' \ + -F 'signers[0][role]=Client' \ + -F 'signers[0][name]=George' \ + -F 'signers[0][email_address]=george@example.com' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ + -F 'test_mode=1' + x-meta: + 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/edit/{signature_request_id}: + put: + tags: + - Signature Request + summary: Edit Signature Request + description: |- + 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* deduct your signature request quota. + operationId: signatureRequestEdit + parameters: + - name: signature_request_id + in: path + 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/SignatureRequestEditRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' + 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: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubFieldOptions = { + dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, + }; + + const signingOptions: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + }; + + const signers1: models.SubSignatureRequestSigner = { + name: "Jack", + emailAddress: "jack@example.com", + order: 0, + }; + + const signers2: models.SubSignatureRequestSigner = { + name: "Jill", + emailAddress: "jill@example.com", + order: 1, + }; + + const signers = [ + signers1, + signers2, + ]; + + const signatureRequestEditRequest: 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", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + metadata: { + "custom_id": 1234, + "custom_text": "NDA #9" + }, + fieldOptions: fieldOptions, + signingOptions: signingOptions, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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", + ) + + 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_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.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + signers=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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/edit/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'title=NDA with Acme Co.' \ + -F 'subject=The NDA we talked about' \ + -F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \ + -F 'signers[0][email_address]=jack@example.com' \ + -F 'signers[0][name]=Jack' \ + -F 'signers[0][order]=0' \ + -F 'signers[1][email_address]=jill@example.com' \ + -F 'signers[1][name]=Jill' \ + -F 'signers[1][order]=1' \ + -F 'cc_email_addresses[]=lawyer1@dropboxsign.com' \ + -F 'cc_email_addresses[]=lawyer2@dropboxsign.com' \ + -F 'metadata[custom_id]=1234' \ + -F 'metadata[custom_text]=NDA #9' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'field_options[date_format]=DD - MM - YYYY' \ + -F 'test_mode=1' + x-meta: + seo: + 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.' + /signature_request/edit_embedded/{signature_request_id}: + put: + tags: + - Signature Request + 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. + + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbedded + parameters: + - name: signature_request_id + in: path + 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: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' + 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: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + }; + + const signers1: models.SubSignatureRequestSigner = { + name: "Jack", + emailAddress: "jack@example.com", + order: 0, + }; + + const signers2: models.SubSignatureRequestSigner = { + name: "Jill", + emailAddress: "jill@example.com", + order: 1, + }; + + const signers = [ + signers1, + signers2, + ]; + + const signatureRequestEditEmbeddedRequest: models.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: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + signingOptions: signingOptions, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/edit_embedded/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'title=NDA with Acme Co.' \ + -F 'subject=The NDA we talked about' \ + -F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \ + -F 'signers[0][email_address]=jack@example.com' \ + -F 'signers[0][name]=Jack' \ + -F 'signers[0][order]=0' \ + -F 'signers[1][email_address]=jill@example.com' \ + -F 'signers[1][name]=Jill' \ + -F 'signers[1][order]=1' \ + -F 'cc_email_addresses[]=lawyer1@dropboxsign.com' \ + -F 'cc_email_addresses[]=lawyer2@dropboxsign.com' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'test_mode=1' + x-meta: + seo: + 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.' + /signature_request/edit_embedded_with_template/{signature_request_id}: + put: + tags: + - Signature Request + 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. + + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbeddedWithTemplate + parameters: + - name: signature_request_id + in: path + 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/SignatureRequestEditEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + }; + + const signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + }; + + const signers = [ + signers1, + ]; + + const signatureRequestEditEmbeddedWithTemplateRequest: models.SignatureRequestEditEmbeddedWithTemplateRequest = { + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/edit_embedded_with_template/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'template_ids[]=c26b8a16784a872da37ea946b9ddec7c1e11dff6' \ + -F 'subject=Purchase Order' \ + -F 'message=Glad we could come to an agreement.' \ + -F 'signers[0][role]=Client' \ + -F 'signers[0][name]=George' \ + -F 'signers[0][email_address]=george@example.com' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'test_mode=1' + x-meta: + 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 edit a SignatureRequest based on the given Template, click here.' + /signature_request/edit_with_template/{signature_request_id}: + put: + tags: + - Signature Request + 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* deduct your signature request quota. + operationId: signatureRequestEditWithTemplate + parameters: + - name: signature_request_id + in: path + 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: + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + }; + + const signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + }; + + const signers = [ + signers1, + ]; + + const ccs1: models.SubCC = { + role: "Accounting", + emailAddress: "accounting@example.com", + }; + + const ccs = [ + ccs1, + ]; + + const customFields1: models.SubCustomField = { + name: "Cost", + editor: "Client", + required: true, + value: "$20,000", + }; + + const customFields = [ + customFields1, + ]; + + const signatureRequestEditWithTemplateRequest: models.SignatureRequestEditWithTemplateRequest = { + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/edit_with_template/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'template_ids[]=61a832ff0d8423f91d503e76bfbcc750f7417c78' \ + -F 'subject=Purchase Order' \ + -F 'message=Glad we could come to an agreement.' \ + -F 'signers[0][role]=Client' \ + -F 'signers[0][name]=George' \ + -F 'signers[0][email_address]=george@example.com' \ + -F 'ccs[0][role]=Accounting' \ + -F 'ccs[0][email_address]=accounting@example.com' \ + -F 'custom_fields[0][name]=Cost' \ + -F 'custom_fields[0][value]=$20,000' \ + -F 'custom_fields[0][editor]=Client' \ + -F 'custom_fields[0][required]=true' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'test_mode=1' + x-meta: + seo: + 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.' + /signature_request/files/{signature_request_id}: + get: + tags: + - Signature Request + summary: Download Files + description: |- + 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. + operationId: signatureRequestFiles + parameters: + - name: signature_request_id + in: path + description: The id of the SignatureRequest to retrieve. + 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 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/signature_request/files/{signature_request_id}?file_type=pdf' \ + -u 'YOUR_API_KEY:' \ + --output downloaded_document.pdf + 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: + 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 + parameters: + - name: signature_request_id + in: path + description: The id of the SignatureRequest to retrieve. + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FileResponseDataUri' + examples: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/signature_request/files_as_data_uri/{signature_request_id}' \ + -u 'YOUR_API_KEY:' + 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: + 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 + parameters: + - name: signature_request_id + in: path + description: The id of the SignatureRequest to retrieve. + 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 + 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/FileResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/signature_request/files_as_file_url/{signature_request_id}' \ + -u 'YOUR_API_KEY:' + 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: + tags: + - Signature Request + 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 retrieve. + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/signature_request/{signature_request_id}' \ + -u 'YOUR_API_KEY:' + 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: + get: + tags: + - Signature Request + 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 + 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/SignatureRequestListResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestListResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + setUsername("YOUR_API_KEY"); + // $config->setAccessToken("YOUR_ACCESS_TOKEN"); + + try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList( + page: 1, + page_size: 20, + ); + + print_r($response); + } catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}"; + } + - lang: csharp + label: C# + source: | + 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( + page: 1, + pageSize: 20 + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_list: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/signature_request/list?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + 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: + 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. + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/release_hold/{signature_request_id}' \ + -u 'YOUR_API_KEY:' + 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: + tags: + - Signature Request + summary: Send Request Reminder + 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. + + **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 send a reminder for. + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestRemindRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/remind/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=john@example.com' + 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: + 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 + parameters: + - name: signature_request_id + in: path + description: The id of the SignatureRequest to remove. + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: {} + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/remove/{signature_request_id}' \ + -u 'YOUR_API_KEY:' + 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: + 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: + example: + $ref: '#/components/examples/SignatureRequestSendRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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) + ->setForceAdvancedSignatureDetails(false); + + $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()}"; + } + - lang: csharp + label: C# + source: | + 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, + force_advanced_signature_details: false, + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubFieldOptions = { + dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, + }; + + const signingOptions: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + force_advanced_signature_details: false, + }; + + const signers1: models.SubSignatureRequestSigner = { + name: "Jack", + emailAddress: "jack@example.com", + order: 0, + }; + + const signers2: models.SubSignatureRequestSigner = { + name: "Jill", + emailAddress: "jill@example.com", + order: 1, + }; + + const signers = [ + signers1, + signers2, + ]; + + const signatureRequestSendRequest: 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", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + metadata: { + "custom_id": 1234, + "custom_text": "NDA #9" + }, + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers, + }; + + apiCaller.signatureRequestSend( + signatureRequestSendRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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); + signingOptions.forceAdvancedSignatureDetails(false); + + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + signing_options.force_advanced_signature_details = false + + 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 + - lang: Python + label: Python + source: | + 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", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + force_advanced_signature_details=False, + ) + + 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_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.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + signers=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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/send' \ + -u 'YOUR_API_KEY:' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'title=NDA with Acme Co.' \ + -F 'subject=The NDA we talked about' \ + -F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \ + -F 'signers[0][email_address]=jack@example.com' \ + -F 'signers[0][name]=Jack' \ + -F 'signers[0][order]=0' \ + -F 'signers[1][email_address]=jill@example.com' \ + -F 'signers[1][name]=Jill' \ + -F 'signers[1][order]=1' \ + -F 'cc_email_addresses[]=lawyer1@dropboxsign.com' \ + -F 'cc_email_addresses[]=lawyer2@dropboxsign.com' \ + -F 'metadata[custom_id]=1234' \ + -F 'metadata[custom_text]=NDA #9' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ + -F 'field_options[date_format]=DD - MM - YYYY' \ + -F 'test_mode=1' + 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: + 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: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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) + ->setForceAdvancedSignatureDetails(false); + + $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()}"; + } + - lang: csharp + label: C# + source: | + 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, + force_advanced_signature_details: false, + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubSigningOptions = { + defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true, + force_advanced_signature_details: false, + }; + + const signers1: models.SubSignatureRequestTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + }; + + const signers = [ + signers1, + ]; + + const ccs1: models.SubCC = { + role: "Accounting", + emailAddress: "accounting@example.com", + }; + + const ccs = [ + ccs1, + ]; + + const customFields1: models.SubCustomField = { + name: "Cost", + editor: "Client", + required: true, + value: "$20,000", + }; + + const customFields = [ + customFields1, + ]; + + const signatureRequestSendWithTemplateRequest: models.SignatureRequestSendWithTemplateRequest = { + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields, + }; + + apiCaller.signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); + + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + signing_options.force_advanced_signature_details = false + + 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 + - lang: Python + label: Python + source: | + 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, + force_advanced_signature_details=False, + ) + + 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_send_with_template_request = models.SignatureRequestSendWithTemplateRequest( + 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_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 SignatureRequestApi#signature_request_send_with_template: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/send_with_template' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'template_ids[]=61a832ff0d8423f91d503e76bfbcc750f7417c78' \ + -F 'subject=Purchase Order' \ + -F 'message=Glad we could come to an agreement.' \ + -F 'signers[0][role]=Client' \ + -F 'signers[0][name]=George' \ + -F 'signers[0][email_address]=george@example.com' \ + -F 'ccs[0][role]=Accounting' \ + -F 'ccs[0][email_address]=accounting@example.com' \ + -F 'custom_fields[0][name]=Cost' \ + -F 'custom_fields[0][value]=$20,000' \ + -F 'custom_fields[0][editor]=Client' \ + -F 'custom_fields[0][required]=true' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=1' \ + -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ + -F 'test_mode=1' + 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}: + post: + tags: + - 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: + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' + 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: + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SignatureRequestUpdateRequest = { + signatureId: "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/signature_request/update/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=john@example.com' \ + -F 'signature_id=2f9781e1a8e2045224d808c153c2e1d3df6f8f2f' + 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: + 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 + 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/TeamAddMemberRequest' + examples: + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' + 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/TeamGetResponse' + examples: + example: + $ref: '#/components/examples/TeamAddMemberResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X PUT 'https://api.hellosign.com/v3/team/add_member' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=george@example.com' + 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: + 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 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamCreateRequest' + examples: + example: + $ref: '#/components/examples/TeamCreateRequest' + 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/TeamGetResponse' + examples: + example: + $ref: '#/components/examples/TeamCreateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_create_request = models.TeamCreateRequest( + name="New Team Name", + ) + + try: + response = api.TeamApi(api_client).team_create( + team_create_request=team_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_create: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/team/create' \ + -u 'YOUR_API_KEY:' \ + -F 'name=New Team Name' + 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: + 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 + 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' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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 TeamDeleteExample + { + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new TeamApi(config).TeamDelete(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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.TeamApi(api_client).team_delete() + except ApiException as e: + print("Exception when calling TeamApi#team_delete: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X DELETE 'https://api.hellosign.com/v3/team/destroy' \ + -u 'YOUR_API_KEY:' + 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: + 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 + 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/TeamGetResponse' + examples: + example: + $ref: '#/components/examples/TeamGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_get() + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_get: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/team' \ + -u 'YOUR_API_KEY:' + 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.' + put: + tags: + - Team + summary: Update Team + description: Updates the name of your Team. + operationId: teamUpdate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamUpdateRequest' + examples: + example: + $ref: '#/components/examples/TeamUpdateRequest' + 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/TeamGetResponse' + examples: + example: + $ref: '#/components/examples/TeamUpdateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_update_request = models.TeamUpdateRequest( + name="New Team Name", + ) + + try: + response = api.TeamApi(api_client).team_update( + team_update_request=team_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_update: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X PUT 'https://api.hellosign.com/v3/team' \ + -u 'YOUR_API_KEY:' \ + -F 'name=New Team Name' + 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: + 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 + 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/TeamGetInfoResponse' + examples: + example: + $ref: '#/components/examples/TeamGetInfoResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/team/info?team_id=4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c' \ + -u 'YOUR_API_KEY:' + 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: + 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 + 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/TeamInvitesResponse' + examples: + example: + $ref: '#/components/examples/TeamInvitesResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - account_access + - basic_account_info + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites( + null // emailAddress + ); + + 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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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_invites() + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_invites: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/team/invites?email_address=user@dropboxsign.com' \ + -u 'YOUR_API_KEY:' + 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}: + 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 + 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/TeamMembersResponse' + examples: + example: + $ref: '#/components/examples/TeamMembersResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/team/members/{team_id}?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + 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: + 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 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamRemoveMemberRequest' + examples: + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' + responses: + '201': + 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/TeamGetResponse' + examples: + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.TeamRemoveMemberRequest = { + emailAddress: "teammate@dropboxsign.com", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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( + email_address="teammate@dropboxsign.com", + new_owner_email_address="new_teammate@dropboxsign.com", + ) + + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/team/remove_member' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=teammate@dropboxsign.com' \ + -F 'new_owner_email_address=new_teammate@dropboxsign.com' + 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}: + get: + tags: + - Team + summary: List Sub Teams + description: Provides a paginated list of sub teams that belong to a given team. + operationId: teamSubTeams + parameters: + - name: team_id + in: path + description: The id of the parent Team. + required: true + 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 + 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/TeamSubTeamsResponse' + examples: + example: + $ref: '#/components/examples/TeamSubTeamsResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - team_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/team/sub_teams/{team_id}?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + 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: + 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 + parameters: + - name: template_id + in: path + description: The id of the Template to give the Account access to. + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateAddUserRequest' + examples: + example: + $ref: '#/components/examples/TemplateAddUserRequest' + 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/TemplateGetResponse' + examples: + example: + $ref: '#/components/examples/TemplateAddUserResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/template/add_user/{template_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=george@dropboxsign.com' + 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: + tags: + - Template + summary: Create Template + description: |- + Creates a template that can be used in future signature requests. + + If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). + + Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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. + operationId: templateCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' + examples: + 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' + 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/TemplateCreateResponse' + examples: + example: + $ref: '#/components/examples/TemplateCreateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubFieldOptions = { + dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, + }; + + const signerRoles1: models.SubTemplateRole = { + name: "Client", + order: 0, + }; + + const signerRoles2: models.SubTemplateRole = { + name: "Witness", + order: 1, + }; + + const signerRoles = [ + signerRoles1, + signerRoles2, + ]; + + const formFieldsPerDocument1: models.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: models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly, + }; + + const formFieldsPerDocument2: models.SubFormFieldsPerDocumentSignature = { + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1, + }; + + const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, + ]; + + const mergeFields1: models.SubMergeField = { + name: "Full Name", + type: models.SubMergeField.TypeEnum.Text, + }; + + const mergeFields2: models.SubMergeField = { + name: "Is Registered?", + type: models.SubMergeField.TypeEnum.Checkbox, + }; + + const mergeFields = [ + mergeFields1, + mergeFields2, + ]; + + const templateCreateRequest: models.TemplateCreateRequest = { + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + }; + + apiCaller.templateCreate( + templateCreateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/template/create' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'title=Test Template' \ + -F 'subject=Please sign this document' \ + -F 'message=For your approval' \ + -F 'signer_roles[0][name]=Client' \ + -F 'signer_roles[0][order]=0' \ + -F 'signer_roles[0][name]=Witness' \ + -F 'signer_roles[0][order]=1' \ + -F 'cc_roles[]=Manager' \ + -F 'merge_fields[0][name]=Full Name' \ + -F 'merge_fields[0][type]=text' \ + -F 'merge_fields[1][name]=Is Registered?' \ + -F 'merge_fields[1][type]=checkbox' \ + -F 'field_options[date_format]=DD - MM - YYYY' \ + -F 'test_mode=1' + 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: + 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 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + examples: + 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' + 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/TemplateCreateEmbeddedDraftResponse' + examples: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubFieldOptions = { + dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, + }; + + const mergeFields1: models.SubMergeField = { + name: "Full Name", + type: models.SubMergeField.TypeEnum.Text, + }; + + const mergeFields2: models.SubMergeField = { + name: "Is Registered?", + type: models.SubMergeField.TypeEnum.Checkbox, + }; + + const mergeFields = [ + mergeFields1, + mergeFields2, + ]; + + const signerRoles1: models.SubTemplateRole = { + name: "Client", + order: 0, + }; + + const signerRoles2: models.SubTemplateRole = { + name: "Witness", + order: 1, + }; + + const signerRoles = [ + signerRoles1, + signerRoles2, + ]; + + const templateCreateEmbeddedDraftRequest: models.TemplateCreateEmbeddedDraftRequest = { + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + fieldOptions: fieldOptions, + mergeFields: mergeFields, + signerRoles: signerRoles, + }; + + apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/template/create_embedded_draft' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'title=Test Template' \ + -F 'subject=Please sign this document' \ + -F 'message=For your approval' \ + -F 'signer_roles[0][name]=Client' \ + -F 'signer_roles[0][order]=0' \ + -F 'signer_roles[0][name]=Witness' \ + -F 'signer_roles[0][order]=1' \ + -F 'cc_roles[]=Manager' \ + -F 'merge_fields[0][name]=Full Name' \ + -F 'merge_fields[0][type]=text' \ + -F 'merge_fields[1][name]=Is Registered?' \ + -F 'merge_fields[1][type]=checkbox' \ + -F 'field_options[date_format]=DD - MM - YYYY' \ + -F 'test_mode=1' + 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: + tags: + - Template + 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 delete. + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 + 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: {} + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/template/delete/{template_id}' \ + -u 'YOUR_API_KEY:' + 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: + 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 + parameters: + - name: template_id + in: path + description: The id of the template files to retrieve. + 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 + responses: + '200': + description: successful operation + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + setUsername("YOUR_API_KEY"); + // $config->setAccessToken("YOUR_ACCESS_TOKEN"); + + try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); + } catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}"; + } + - lang: csharp + label: C# + source: | + 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" + ); + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling TemplateApi#template_files: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/template/files/{template_id}?file_type=pdf' \ + -u 'YOUR_API_KEY:' \ + --output downloaded_document.pdf + 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: + 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 + 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/FileResponseDataUri' + examples: + example: + $ref: '#/components/examples/TemplateFilesResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/template/files_as_data_uri/{template_id}' \ + -u 'YOUR_API_KEY:' + 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: + 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 + 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/FileResponse' + examples: + example: + $ref: '#/components/examples/TemplateFilesResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/template/files_as_file_url/{template_id}' \ + -u 'YOUR_API_KEY:' + 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: + tags: + - 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 + 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/TemplateGetResponse' + examples: + example: + $ref: '#/components/examples/TemplateGetResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/template/{template_id}' \ + -u 'YOUR_API_KEY:' + 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: + get: + tags: + - Template + summary: List Templates + description: |- + Returns a list of the Templates that are accessible by you. + + 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 + 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/TemplateListResponse' + examples: + example: + $ref: '#/components/examples/TemplateListResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + setUsername("YOUR_API_KEY"); + // $config->setAccessToken("YOUR_ACCESS_TOKEN"); + + try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList( + page: 1, + page_size: 20, + ); + + print_r($response); + } catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}"; + } + - lang: csharp + label: C# + source: | + 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( + page: 1, + pageSize: 20 + ); + + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_list: %s\n" % e) + - lang: cURL + label: cURL + source: | + curl -X GET 'https://api.hellosign.com/v3/template/list?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' + 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: + tags: + - 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/TemplateRemoveUserRequest' + examples: + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' + 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/TemplateGetResponse' + examples: + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/template/remove_user/{template_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'email_address=george@dropboxsign.com' + 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: + tags: + - Template + summary: Update Template Files + 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. + + 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: template_id + in: path + description: The ID of the template whose files to update. + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateUpdateFilesRequest' + examples: + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateUpdateFilesRequest' + 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/TemplateUpdateFilesResponse' + examples: + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - template_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/template/update_files/{template_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + 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: + 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' + 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: + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubUnclaimedDraftSigner = { + name: "Jack", + emailAddress: "jack@example.com", + order: 0, + }; + + const signers = [ + signers1, + ]; + + const unclaimedDraftCreateRequest: models.UnclaimedDraftCreateRequest = { + type: models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: true, + files: [ + fs.createReadStream("./example_signature_request.pdf"), + ], + signers: signers, + }; + + apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/unclaimed_draft/create' \ + -u 'YOUR_API_KEY:' \ + -F 'type=request_signature' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'subject=The NDA we talked about' \ + -F 'message=Please sign this NDA and then we can discuss more. Let me know if you have any questions.' \ + -F 'signers[0][email_address]=jack@example.com' \ + -F 'signers[0][name]=Jack' \ + -F 'signers[0][order]=0' \ + -F 'signers[1][email_address]=jill@example.com' \ + -F 'signers[1][name]=Jill' \ + -F 'signers[1][order]=1' \ + -F 'cc_email_addresses[0]=lawyer1@dropboxsign.com' \ + -F 'cc_email_addresses[1]=lawyer2@dropboxsign.com' \ + -F 'metadata[0][custom_id]=1234' \ + -F 'metadata[0][custom_text]=NDA #9' \ + -F 'signing_options[draw]=1' \ + -F 'signing_options[type]=1' \ + -F 'signing_options[upload]=1' \ + -F 'signing_options[phone]=0' \ + -F 'signing_options[default_type]=draw' \ + -F 'field_options[date_format]=DD - MM - YYYY' \ + -F 'test_mode=1' + 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: + 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. + + **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: + 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' + 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: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.UnclaimedDraftCreateEmbeddedRequest = { + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: true, + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/unclaimed_draft/create_embedded' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'requester_email_address=jack@dropboxsign.com' \ + -F 'test_mode=1' + 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: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + 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: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.SubCC = { + role: "Accounting", + emailAddress: "accounting@dropboxsign.com", + }; + + const ccs = [ + ccs1, + ]; + + const signers1: models.SubUnclaimedDraftTemplateSigner = { + role: "Client", + name: "George", + emailAddress: "george@example.com", + }; + + const signers = [ + signers1, + ]; + + const unclaimedDraftCreateEmbeddedWithTemplateRequest: models.UnclaimedDraftCreateEmbeddedWithTemplateRequest = { + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + testMode: false, + ccs: ccs, + signers: signers, + }; + + apiCaller.unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest, + ).then(response => { + console.log(response.body); + }).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate:"); + console.log(error.body); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/unclaimed_draft/create_embedded_with_template' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'template_ids[]=61a832ff0d8423f91d503e76bfbcc750f7417c78' \ + -F 'requester_email_address=jack@dropboxsign.com' \ + -F 'signers[0][role]=Client' \ + -F 'signers[0][name]=George' \ + -F 'signers[0][email_address]=george@example.com' \ + -F 'ccs[0][role]=Accounting' \ + -F 'ccs[0][email_address]=accounting@dropboxsign.com' \ + -F 'test_mode=1' + 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: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' + 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: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - api_key: [] + - oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - lang: PHP + label: PHP + source: | + 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()}"; + } + - lang: csharp + label: C# + source: | + 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); + } + } + } + - lang: TypeScript + label: TypeScript + source: | + 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: models.UnclaimedDraftEditAndResendRequest = { + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + 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); + }); + - lang: Java + label: Java + source: | + 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.math.BigDecimal; + 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(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("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(); + } + } + } + - lang: Ruby + label: Ruby + source: | + 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 + - lang: Python + label: Python + source: | + 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) + - lang: cURL + label: cURL + source: | + curl -X POST 'https://api.hellosign.com/v3/unclaimed_draft/edit_and_resend/{signature_request_id}' \ + -u 'YOUR_API_KEY:' \ + -F 'client_id=YOUR_CLIENT_ID' \ + -F 'test_mode=1' + 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 + type: object + ApiAppCreateRequest: + required: + - name + - domains + properties: + callback_url: + description: The URL at which the ApiApp should receive event callbacks. + type: string + custom_logo_file: + description: An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) + type: string + format: binary + domains: + description: The domain names the ApiApp will be associated with. + type: array + items: + type: string + maxItems: 10 + minItems: 1 + name: + description: The name you want to assign to the ApiApp. + type: string + oauth: + $ref: '#/components/schemas/SubOAuth' + options: + $ref: '#/components/schemas/SubOptions' + white_labeling_options: + $ref: '#/components/schemas/SubWhiteLabelingOptions' + type: object + ApiAppUpdateRequest: + properties: + callback_url: + description: The URL at which the API App should receive event callbacks. + type: string + custom_logo_file: + description: An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) + type: string + format: binary + domains: + description: The domain names the ApiApp will be associated with. + type: array + items: + type: string + maxItems: 10 + name: + description: The name you want to assign to the ApiApp. + type: string + oauth: + $ref: '#/components/schemas/SubOAuth' + options: + $ref: '#/components/schemas/SubOptions' + white_labeling_options: + $ref: '#/components/schemas/SubWhiteLabelingOptions' + type: object + EmbeddedEditUrlRequest: + properties: + allow_edit_ccs: + description: This allows the requester to enable/disable to add or change CC roles when editing the template. + type: boolean + default: false + cc_roles: + description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.' + type: array + items: + type: string + editor_options: + $ref: '#/components/schemas/SubEditorOptions' + force_signer_roles: + description: Provide users the ability to review/edit the template signer roles. + type: boolean + default: false + force_subject_message: + description: Provide users the ability to review/edit the template subject and message. + type: boolean + default: false + merge_fields: + description: |- + Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. + + Remove all merge fields on the template by passing an empty array `[]`. + type: array + items: + $ref: '#/components/schemas/SubMergeField' + preview_only: + description: |- + This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). + + **NOTE:** This parameter overwrites `show_preview=true` (if set). + type: boolean + default: false + show_preview: + description: This allows the requester to enable the editor/preview experience. + type: boolean + default: false + show_progress_stepper: + description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + type: boolean + default: true + test_mode: + description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.' + type: boolean + default: false + type: object + FaxLineAddUserRequest: + required: + - number + properties: + number: + description: The Fax Line number + type: string + account_id: + description: Account ID + type: string + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + email_address: + description: Email address + type: string + format: email + type: object + FaxLineAreaCodeGetStateEnum: + type: string + 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 + FaxLineAreaCodeGetProvinceEnum: + type: string + enum: + - AB + - BC + - MB + - NB + - NL + - NT + - NS + - NU + - 'ON' + - PE + - QC + - SK + - YT + FaxLineAreaCodeGetCountryEnum: + type: string + enum: + - CA + - US + - UK + FaxLineCreateRequest: + required: + - area_code + - country + properties: + area_code: + description: Area code of the new Fax Line + type: integer + country: + description: Country of the area code + type: string + enum: + - CA + - US + - UK + city: + description: City of the area code + type: string + account_id: + description: Account ID of the account that will be assigned this new Fax Line + type: string + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + type: object + FaxLineDeleteRequest: + required: + - number + properties: + number: + description: The Fax Line number + type: string + type: object + FaxLineRemoveUserRequest: + required: + - number + properties: + number: + description: The Fax Line number + type: string + account_id: + description: Account ID of the user to remove access + type: string + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + email_address: + description: Email address of the user to remove access + type: string + format: email + type: object + FaxSendRequest: + required: + - recipient + properties: + 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: + description: Fax Send From Sender (used only with fax number) + type: string + example: sender@example.com + files: + 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: |- + 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 + test_mode: + description: API Test Mode Setting + type: boolean + default: false + cover_page_to: + description: Fax cover page recipient information + type: string + example: Recipient Name + cover_page_from: + description: Fax cover page sender information + type: string + example: Sender Name + cover_page_message: + description: Fax Cover Page Message + type: string + example: Please find the attached documents. + title: + description: Fax Title + type: string + example: Fax Title + type: object + OAuthTokenGenerateRequest: + required: + - client_id + - client_secret + - code + - state + - grant_type + properties: + client_id: + description: The client id of the app requesting authorization. + type: string + client_secret: + description: The secret token of your app. + type: string + code: + description: The code passed to your callback when the user granted access. + type: string + grant_type: + description: When generating a new token use `authorization_code`. + type: string + default: authorization_code + state: + description: Same as the state you specified earlier. + type: string + type: object + OAuthTokenRefreshRequest: + required: + - grant_type + - refresh_token + properties: + grant_type: + description: When refreshing an existing token use `refresh_token`. + type: string + default: refresh_token + refresh_token: + description: The token provided when you got the expired access token. + type: string + client_id: + description: 'The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.' + type: string + client_secret: + description: 'The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings.' + type: string + type: object + ReportCreateRequest: + required: + - start_date + - end_date + - report_type + properties: + 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 + - sms_activity + - fax_usage + 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 + SignatureRequestBulkSendWithTemplateRequest: + required: + - 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: 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: |- + 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 + 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://sign.dropbox.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. 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://sign.dropbox.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. 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 + properties: + email_address: + description: The email address of the signer to send a reminder to. + type: string + format: email + name: + description: The name of the signer to send a reminder to. Include if two or more signers share an email address. + type: string + type: object + SignatureRequestSendRequest: + 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://sign.dropbox.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. 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 + SignatureRequestSendWithTemplateRequest: + 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://sign.dropbox.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. 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 + SignatureRequestUpdateRequest: + required: + - signature_id + properties: + email_address: + description: |- + The new email address for the recipient. + + This will generate a new `signature_id` value. + + **NOTE:** Optional if `name` is provided. + type: string + format: email + name: + description: |- + The new name for the recipient. + + **NOTE:** Optional if `email_address` is provided. + type: string + signature_id: + description: The signature ID for the recipient. + type: string + expires_at: + description: The new time 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 + SubAttachment: + required: + - name + - signer_index + properties: + instructions: + description: The instructions for uploading the attachment. + type: string + name: + description: The name of attachment. + type: string + required: + description: Determines if the attachment must be uploaded. + type: boolean + default: false + signer_index: + description: |- + The signer's index in the `signers` parameter (0-based indexing). + + **NOTE:** Only one signer can be assigned per attachment. + type: integer + type: object + SubBulkSignerList: + properties: + custom_fields: + description: An array of custom field values. + type: array + items: + $ref: '#/components/schemas/SubBulkSignerListCustomField' + signers: + description: |- + Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. + + Currently only templates with a single role are supported. All signers must have the same `role` value. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + type: object + SubBulkSignerListCustomField: + required: + - name + - value + properties: + name: + description: The name of the custom field. Must be the field's `name` or `api_id`. + type: string + value: + description: The value of the custom field. + type: string + type: object + SubCC: + required: + - role + - email_address + properties: + role: + description: Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. + type: string + email_address: + description: The email address of the CC recipient. + type: string + format: email + type: object + SubCustomField: + 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. + required: + - name + properties: + editor: + description: |- + Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. + + **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. + type: string + name: + description: 'The name of a custom field. When working with pre-filled data, the custom field''s name must have a matching merge field name or the field will remain empty on the document during signing.' + type: string + required: + description: 'Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.' + type: boolean + default: false + value: + description: The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. + type: string + type: object + SubEditorOptions: + description: This allows the requester to specify editor options when a preparing a document + properties: + allow_edit_signers: + description: Allows requesters to edit the list of signers + type: boolean + default: false + allow_edit_documents: + description: 'Allows requesters to edit documents, including delete and add' + type: boolean + default: false + type: object + SubFieldOptions: + description: This allows the requester to specify field options for a signature request. + required: + - date_format + properties: + date_format: + description: |- + Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) + + **NOTE:** Only available for Premium and higher. + type: string + enum: + - MM / DD / YYYY + - MM - DD - YYYY + - DD / MM / YYYY + - DD - MM - YYYY + - YYYY / MM / DD + - YYYY - MM - DD + x-enum-varnames: + - MMDDYYYY + - MM_DD_YYYY + - DDMMYYYY + - DD_MM_YYYY + - YYYYMMDD + - YYYY_MM_DD + type: object + SubFormFieldGroup: + required: + - group_id + - group_label + - requirement + properties: + group_id: + description: ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. + type: string + group_label: + description: Name of the group + type: string + requirement: + description: |- + Examples: `require_0-1` `require_1` `require_1-ormore` + + - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). + - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). + - Radio groups require **at least** two fields per group. + type: string + type: object + SubFormFieldRule: + required: + - id + - trigger_operator + - triggers + - actions + properties: + id: + description: Must be unique across all defined rules. + type: string + trigger_operator: + description: Currently only `AND` is supported. Support for `OR` is being worked on. + type: string + default: AND + triggers: + description: 'An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRuleTrigger' + maxItems: 1 + minItems: 1 + actions: + description: 'An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRuleAction' + minItems: 1 + type: object + SubFormFieldRuleAction: + required: + - hidden + - type + properties: + field_id: + description: |- + **field_id** or **group_id** is required, but not both. + + Must reference the `api_id` of an existing field defined within `form_fields_per_document`. + + Cannot use with `group_id`. Trigger and action fields must belong to the same signer. + type: string + group_id: + description: |- + **group_id** or **field_id** is required, but not both. + + Must reference the ID of an existing group defined within `form_field_groups`. + + Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. + type: string + hidden: + description: '`true` to hide the target field when rule is satisfied, otherwise `false`.' + type: boolean + type: + type: string + enum: + - change-field-visibility + - change-group-visibility + type: object + SubFormFieldRuleTrigger: + required: + - id + - operator + properties: + id: + description: Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. + type: string + operator: + description: |- + Different field types allow different `operator` values: + - Field type of **text**: + - **is**: exact match + - **not**: not exact match + - **match**: regular expression, without /. Example: + - OK `[a-zA-Z0-9]` + - Not OK `/[a-zA-Z0-9]/` + - Field type of **dropdown**: + - **is**: exact match, single value + - **not**: not exact match, single value + - **any**: exact match, array of values. + - **none**: not exact match, array of values. + - Field type of **checkbox**: + - **is**: exact match, single value + - **not**: not exact match, single value + - Field type of **radio**: + - **is**: exact match, single value + - **not**: not exact match, single value + type: string + enum: + - any + - is + - match + - none + - not + value: + description: |- + **value** or **values** is required, but not both. + + The value to match against **operator**. + + - When **operator** is one of the following, **value** must be `String`: + - `is` + - `not` + - `match` + + Otherwise, + - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` + - **radio**: When **type** of trigger is **radio**, **value** must be `1` + type: string + values: + description: |- + **values** or **value** is required, but not both. + + The values to match against **operator** when it is one of the following: + + - `any` + - `none` + type: array + items: + type: string + type: object + SubFormFieldsPerDocumentCheckbox: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + - is_checked + properties: + type: + description: A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. + type: string + default: checkbox + group: + description: String referencing group defined in `form_field_groups` parameter. + type: string + is_checked: + description: '`true` for checking the checkbox field by default, otherwise `false`.' + type: boolean + type: object + SubFormFieldsPerDocumentCheckboxMerge: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + properties: + type: + description: A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. + type: string + default: checkbox-merge + type: object + SubFormFieldsPerDocumentDateSigned: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + properties: + type: + description: A date. Use the `SubFormFieldsPerDocumentDateSigned` class. + type: string + default: date_signed + font_family: + description: Font family for the field. + type: string + enum: + - helvetica + - arial + - courier + - calibri + - cambria + - georgia + - times + - trebuchet + - verdana + - roboto + - robotoMono + - notoSans + - notoSerif + - notoCJK-JP-Regular + - notoHebrew-Regular + - notoSanThaiMerged + font_size: + description: |- + The initial px font size for the field contents. Can be any integer value between `7` and `49`. + + **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. + type: integer + default: 12 + type: object + SubFormFieldsPerDocumentDropdown: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + - options + properties: + type: + description: An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. + type: string + default: dropdown + options: + description: Array of string values representing dropdown values. + type: array + items: + type: string + minItems: 1 + content: + description: Selected value in `options` array. Value must exist in array. + type: string + font_family: + description: Font family for the field. + type: string + enum: + - helvetica + - arial + - courier + - calibri + - cambria + - georgia + - times + - trebuchet + - verdana + - roboto + - robotoMono + - notoSans + - notoSerif + - notoCJK-JP-Regular + - notoHebrew-Regular + - notoSanThaiMerged + font_size: + description: |- + The initial px font size for the field contents. Can be any integer value between `7` and `49`. + + **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. + type: integer + default: 12 + type: object + SubFormFieldsPerDocumentHyperlink: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + - content + - content_url + properties: + type: + description: A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. + type: string + default: hyperlink + content: + description: Link Text. + type: string + content_url: + description: Link URL. + type: string + font_family: + description: Font family for the field. + type: string + enum: + - helvetica + - arial + - courier + - calibri + - cambria + - georgia + - times + - trebuchet + - verdana + - roboto + - robotoMono + - notoSans + - notoSerif + - notoCJK-JP-Regular + - notoHebrew-Regular + - notoSanThaiMerged + font_size: + description: |- + The initial px font size for the field contents. Can be any integer value between `7` and `49`. + + **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. + type: integer + default: 12 + type: object + SubFormFieldsPerDocumentInitials: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + properties: + type: + description: An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. + type: string + default: initials + type: object + SubFormFieldsPerDocumentRadio: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + - group + - is_checked + properties: + type: + description: An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. + type: string + default: radio + group: + description: String referencing group defined in `form_field_groups` parameter. + type: string + is_checked: + description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.' + type: boolean + type: object + SubFormFieldsPerDocumentSignature: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + properties: + type: + description: A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. + type: string + default: signature + type: object + SubFormFieldsPerDocumentText: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + - options + properties: + type: + description: A text input field. Use the `SubFormFieldsPerDocumentText` class. + type: string + default: text + placeholder: + description: Placeholder value for text field. + type: string + auto_fill_type: + description: Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. + type: string + link_id: + description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.' + type: string + masked: + description: Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. + type: boolean + validation_type: + description: |- + Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + + **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + type: string + enum: + - numbers_only + - letters_only + - phone_number + - bank_routing_number + - bank_account_number + - email_address + - zip_code + - social_security_number + - employer_identification_number + - custom_regex + validation_custom_regex: + type: string + validation_custom_regex_format_label: + type: string + content: + description: Content of a `me_now` text field + type: string + font_family: + description: Font family for the field. + type: string + enum: + - helvetica + - arial + - courier + - calibri + - cambria + - georgia + - times + - trebuchet + - verdana + - roboto + - robotoMono + - notoSans + - notoSerif + - notoCJK-JP-Regular + - notoHebrew-Regular + - notoSanThaiMerged + font_size: + description: |- + The initial px font size for the field contents. Can be any integer value between `7` and `49`. + + **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. + type: integer + default: 12 + type: object + SubFormFieldsPerDocumentTextMerge: + description: This class extends `SubFormFieldsPerDocumentBase`. + allOf: + - + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + - required: + - type + properties: + type: + description: A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + type: string + default: text-merge + font_family: + description: Font family for the field. + type: string + enum: + - helvetica + - arial + - courier + - calibri + - cambria + - georgia + - times + - trebuchet + - verdana + - roboto + - robotoMono + - notoSans + - notoSerif + - notoCJK-JP-Regular + - notoHebrew-Regular + - notoSanThaiMerged + font_size: + description: |- + The initial px font size for the field contents. Can be any integer value between `7` and `49`. + + **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. + type: integer + default: 12 + type: object + SubFormFieldsPerDocumentTypeEnum: + type: string + enum: + - checkbox + - checkbox-merge + - date_signed + - dropdown + - hyperlink + - initials + - signature + - radio + - text + - text-merge + SubFormFieldsPerDocumentFontEnum: + type: string + enum: + - helvetica + - arial + - courier + - calibri + - cambria + - georgia + - times + - trebuchet + - verdana + - roboto + - robotoMono + - notoSans + - notoSerif + - notoCJK-JP-Regular + - notoHebrew-Regular + - notoSanThaiMerged + SubFormFieldsPerDocumentBase: + 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` + required: + - document_index + - api_id + - type + - required + - signer + - width + - height + - x + - 'y' + properties: + document_index: + description: Represents the integer index of the `file` or `file_url` document the field should be attached to. + type: integer + api_id: + description: An identifier for the field that is unique across all documents in the request. + type: string + height: + description: Size of the field in pixels. + type: integer + name: + description: Display name for the field. + type: string + page: + description: |- + Page in the document where the field should be placed (requires documents be PDF files). + + - When the page number parameter is supplied, the API will use the new coordinate system. + - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. + type: integer + nullable: true + required: + description: Whether this field is required. + type: boolean + signer: + description: |- + Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. + + **NOTE:** To set the value of the field as the preparer you must set this to `me_now` + + **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. + type: string + x-int-or-string: true + type: + type: string + width: + description: Size of the field in pixels. + type: integer + x: + description: Location coordinates of the field in pixels. + type: integer + 'y': + description: Location coordinates of the field in pixels. + type: integer + type: object + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/SubFormFieldsPerDocumentText' + dropdown: '#/components/schemas/SubFormFieldsPerDocumentDropdown' + hyperlink: '#/components/schemas/SubFormFieldsPerDocumentHyperlink' + checkbox: '#/components/schemas/SubFormFieldsPerDocumentCheckbox' + radio: '#/components/schemas/SubFormFieldsPerDocumentRadio' + signature: '#/components/schemas/SubFormFieldsPerDocumentSignature' + date_signed: '#/components/schemas/SubFormFieldsPerDocumentDateSigned' + initials: '#/components/schemas/SubFormFieldsPerDocumentInitials' + text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge' + checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge' + x-internal-class: true + x-base-class: true + SubSignatureRequestGroupedSigners: + required: + - group + - signers + properties: + group: + description: The name of the group. + type: string + order: + description: The order the group is required to sign in. Use this instead of Signer-level `order`. + type: integer + nullable: true + signers: + description: |- + Signers belonging to this Group. + + **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + type: object + SubMergeField: + required: + - name + - type + properties: + name: + description: The name of the merge field. Must be unique. + type: string + type: + description: The type of merge field. + type: string + enum: + - text + - checkbox + x-enumDescriptions: + text: Sets merge [field type](/api/reference/constants/#field-types) to `text`. + checkbox: Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`. + type: object + SubOAuth: + description: OAuth related parameters. + properties: + callback_url: + description: The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + type: string + scopes: + description: A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + type: array + items: + type: string + enum: + - request_signature + - basic_account_info + - account_access + - signature_request_access + - template_access + - team_access + - api_app_access + - '' + type: object + SubOptions: + description: Additional options supported by API App. + properties: + can_insert_everywhere: + description: 'Determines if signers can use "Insert Everywhere" when signing a document.' + type: boolean + default: false + type: object + SubSignatureRequestSigner: + required: + - name + - email_address + properties: + name: + description: The name of the signer. + type: string + email_address: + description: The email address of the signer. + type: string + format: email + order: + description: The order the signer is required to sign in. + type: integer + nullable: true + pin: + description: The 4- to 12-character access code that will secure this signer's signature page. + type: string + maxLength: 12 + minLength: 4 + sms_phone_number: + description: |- + An E.164 formatted phone number. + + 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. + type: string + sms_phone_number_type: + description: |- + Specifies the feature used with the `sms_phone_number`. Default `authentication`. + + If `authentication`, signer is sent a verification code via SMS that is required to access the document. + + If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + type: string + enum: + - authentication + - delivery + type: object + SubSignatureRequestTemplateSigner: + required: + - role + - name + - email_address + properties: + role: + description: Must match an existing role in chosen Template(s). It's case-sensitive. + type: string + name: + description: The name of the signer. + type: string + email_address: + description: The email address of the signer. + type: string + format: email + pin: + description: The 4- to 12-character access code that will secure this signer's signature page. + type: string + maxLength: 12 + minLength: 4 + sms_phone_number: + description: |- + An E.164 formatted phone number. + + 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. + type: string + sms_phone_number_type: + description: |- + Specifies the feature used with the `sms_phone_number`. Default `authentication`. + + If `authentication`, signer is sent a verification code via SMS that is required to access the document. + + If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + type: string + enum: + - authentication + - delivery + type: object + SubUnclaimedDraftSigner: + required: + - name + - email_address + properties: + email_address: + description: The email address of the signer. + type: string + format: email + name: + description: The name of the signer. + type: string + order: + description: The order the signer is required to sign in. + type: integer + nullable: true + type: object + SubUnclaimedDraftTemplateSigner: + required: + - role + - name + - email_address + properties: + role: + description: Must match an existing role in chosen Template(s). + type: string + name: + description: The name of the signer filling the role of `role`. + type: string + email_address: + description: The email address of the signer filling the role of `role`. + type: string + format: email + type: object + SubTemplateRole: + properties: + name: + description: The role name of the signer that will be displayed when the template is used to create a signature request. + type: string + order: + description: The order in which this signer role is required to sign. + type: integer + nullable: true + type: object + SubSigningOptions: + description: |- + This allows the requester to specify the types allowed for creating a signature and specify another signing options. + + **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + + **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + required: + - default_type + properties: + default_type: + description: The default type shown (limited to the listed types) + type: string + enum: + - draw + - phone + - type + - upload + draw: + description: Allows drawing the signature + type: boolean + default: false + phone: + description: Allows using a smartphone to email the signature + type: boolean + default: false + type: + description: Allows typing the signature + type: boolean + default: false + upload: + description: Allows uploading the signature + type: boolean + default: false + force_advanced_signature_details: + description: Turning on advanced signature details for the signature request + type: boolean + default: false + type: object + SubWhiteLabelingOptions: + description: |- + An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) + + Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + properties: + header_background_color: + type: string + default: '#1a1a1a' + legal_version: + type: string + default: terms1 + enum: + - terms1 + - terms2 + link_color: + type: string + default: '#0061FE' + page_background_color: + type: string + default: '#f7f8f9' + primary_button_color: + type: string + default: '#0061FE' + primary_button_color_hover: + type: string + default: '#0061FE' + primary_button_text_color: + type: string + default: '#ffffff' + primary_button_text_color_hover: + type: string + default: '#ffffff' + secondary_button_color: + type: string + default: '#ffffff' + secondary_button_color_hover: + type: string + default: '#ffffff' + secondary_button_text_color: + type: string + default: '#0061FE' + secondary_button_text_color_hover: + type: string + default: '#0061FE' + text_color1: + type: string + default: '#808080' + text_color2: + type: string + default: '#ffffff' + reset_to_default: + description: Resets white labeling options to defaults. Only useful when updating an API App. + type: boolean + type: object + TeamAddMemberRequest: + properties: + account_id: + description: |- + `account_id` or `email_address` is required. If both are provided, the account id prevails. + + Account id of the user to invite to your Team. + type: string + email_address: + description: |- + `account_id` or `email_address` is required, If both are provided, the account id prevails. + + Email address of the user to invite to your Team. + type: string + format: email + role: + description: |- + A role member will take in a new Team. + + **NOTE:** This parameter is used only if `team_id` is provided. + type: string + enum: + - Member + - Developer + - Team Manager + - Admin + type: object + TeamCreateRequest: + properties: + name: + description: The name of your Team. + type: string + default: Untitled Team + type: object + TeamRemoveMemberRequest: + properties: + account_id: + description: |- + **account_id** or **email_address** is required. If both are provided, the account id prevails. + + Account id to remove from your Team. + type: string + email_address: + description: |- + **account_id** or **email_address** is required. If both are provided, the account id prevails. + + Email address of the Account to remove from your Team. + type: string + format: email + new_owner_email_address: + description: |- + The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account. + + **NOTE:** Only available for Enterprise plans. + type: string + format: email + new_team_id: + description: Id of the new Team. + type: string + new_role: + description: |- + A new role member will take in a new Team. + + **NOTE:** This parameter is used only if `new_team_id` is provided. + type: string + enum: + - Member + - Developer + - Team Manager + - Admin + type: object + TeamUpdateRequest: + properties: + name: + description: The name of your Team. + type: string + type: object + TemplateAddUserRequest: + properties: + account_id: + description: |- + The id of the Account to give access to the Template. + **NOTE:** The account id prevails if email address is also provided. + type: string + email_address: + description: |- + The email address of the Account to give access to the Template. + **NOTE:** The account id prevails if it is also provided. + type: string + format: email + skip_notification: + description: 'If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.' + type: boolean + default: false + type: object + TemplateCreateRequest: + required: + - signer_roles + - form_fields_per_document + 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 + 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_roles: + description: The CC roles that must be assigned when using the template to send a signature request + type: array + items: + type: string + client_id: + description: Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. + type: string + 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' + merge_fields: + description: |- + Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. + If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. + type: array + items: + $ref: '#/components/schemas/SubMergeField' + message: + description: The default template email message. + 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: {} + signer_roles: + description: An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + type: array + items: + $ref: '#/components/schemas/SubTemplateRole' + subject: + description: The template title (alias). + type: string + maxLength: 200 + test_mode: + description: 'Whether this is a test, the signature request created from this draft 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 + use_preexisting_fields: + description: Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). + type: boolean + default: false + type: object + TemplateCreateEmbeddedDraftRequest: + 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 + allow_ccs: + description: This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. + type: boolean + default: true + 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_roles: + description: The CC roles that must be assigned when using the template to send a signature request + type: array + items: + type: string + client_id: + description: Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. + type: string + editor_options: + $ref: '#/components/schemas/SubEditorOptions' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + force_signer_roles: + description: Provide users the ability to review/edit the template signer roles. + type: boolean + default: false + force_subject_message: + description: Provide users the ability to review/edit the template subject and message. + type: boolean + default: false + 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' + merge_fields: + description: |- + Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. + If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. + type: array + items: + $ref: '#/components/schemas/SubMergeField' + message: + description: The default template email message. + 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: {} + show_preview: + description: |- + This allows the requester to enable the editor/preview experience. + + - `show_preview=true`: Allows requesters to enable the editor/preview experience. + - `show_preview=false`: Allows requesters to disable the editor/preview experience. + type: boolean + default: false + show_progress_stepper: + description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + type: boolean + default: true + signer_roles: + description: An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + type: array + items: + $ref: '#/components/schemas/SubTemplateRole' + skip_me_now: + description: Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. + type: boolean + default: false + subject: + description: The template title (alias). + type: string + maxLength: 200 + test_mode: + description: 'Whether this is a test, the signature request created from this draft 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 + use_preexisting_fields: + description: Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). + type: boolean + default: false + type: object + TemplateRemoveUserRequest: + properties: + account_id: + description: The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. + type: string + email_address: + description: The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. + type: string + format: email + type: object + TemplateUpdateFilesRequest: + properties: + client_id: + description: Client id of the app you're using to update this template. + type: string + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to use for the template. + + 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 use for the template. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + message: + description: The new default template email message. + type: string + maxLength: 5000 + subject: + description: The new default template email subject. + type: string + maxLength: 100 + test_mode: + description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + type: object + UnclaimedDraftCreateRequest: + description: '' + required: + - type + 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 + allow_decline: + description: Allows signers to decline to sign a document if `true`. Defaults to `false`. + 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 used to create the draft. 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: Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. + 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: {} + show_progress_stepper: + description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + type: boolean + default: true + signers: + description: Add Signers to your Unclaimed Draft Signature Request. + type: array + items: + $ref: '#/components/schemas/SubUnclaimedDraftSigner' + 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: 200 + test_mode: + description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + type: + description: 'The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.' + type: string + enum: + - send_document + - request_signature + use_preexisting_fields: + description: Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. + type: boolean + default: false + use_text_tags: + description: Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. + 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. + + **NOTE:** This does not correspond to the **expires_at** returned in the response. + type: integer + nullable: true + type: object + UnclaimedDraftCreateEmbeddedRequest: + description: '' + required: + - client_id + - requester_email_address + 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 + allow_ccs: + description: This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. + type: boolean + default: true + 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: Client id of the app used to create the draft. 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' + editor_options: + $ref: '#/components/schemas/SubEditorOptions' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + force_signer_page: + description: Provide users the ability to review/edit the signers. + type: boolean + default: false + force_subject_message: + description: Provide users the ability to review/edit the subject and message. + type: boolean + default: false + 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: Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. + type: boolean + default: false + hold_request: + description: The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. + type: boolean + default: false + is_for_embedded_signing: + description: The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. + 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: {} + requester_email_address: + description: 'The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.' + type: string + format: email + requesting_redirect_url: + description: The URL you want signers redirected to after they successfully request a signature. + type: string + show_preview: + description: |- + This allows the requester to enable the editor/preview experience. + + - `show_preview=true`: Allows requesters to enable the editor/preview experience. + - `show_preview=false`: Allows requesters to disable the editor/preview experience. + type: boolean + show_progress_stepper: + description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + type: boolean + default: true + signers: + description: Add Signers to your Unclaimed Draft Signature Request. + type: array + items: + $ref: '#/components/schemas/SubUnclaimedDraftSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: The URL you want signers redirected to after they successfully sign. + type: string + skip_me_now: + description: Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. + type: boolean + default: false + subject: + description: The subject in the email that will be sent to the signers. + type: string + maxLength: 200 + test_mode: + description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + type: + description: 'The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.' + type: string + default: request_signature + enum: + - send_document + - request_signature + use_preexisting_fields: + description: Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. + type: boolean + default: false + use_text_tags: + description: Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. + 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. + + **NOTE:** This does not correspond to the **expires_at** returned in the response. + type: integer + nullable: true + type: object + UnclaimedDraftCreateEmbeddedWithTemplateRequest: + required: + - client_id + - requester_email_address + - template_ids + properties: + 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 + 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 used to create the draft. 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' + editor_options: + $ref: '#/components/schemas/SubEditorOptions' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + files: + description: |- + Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. + + **files** or **file_urls[]** is required, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. + + **files** or **file_urls[]** is required, but not both. + type: array + items: + type: string + force_signer_roles: + description: Provide users the ability to review/edit the template signer roles. + type: boolean + default: false + force_subject_message: + description: Provide users the ability to review/edit the template subject and message. + type: boolean + default: false + hold_request: + description: The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. + type: boolean + default: false + is_for_embedded_signing: + description: The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. + 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: {} + preview_only: + description: |- + This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). + + - `preview_only=true`: Allows requesters to enable the preview only experience. + - `preview_only=false`: Allows requesters to disable the preview only experience. + + **NOTE:** This parameter overwrites `show_preview=1` (if set). + type: boolean + default: false + requester_email_address: + description: The email address of the user that should be designated as the requester of this draft. + type: string + format: email + requesting_redirect_url: + description: The URL you want signers redirected to after they successfully request a signature. + type: string + show_preview: + description: |- + This allows the requester to enable the editor/preview experience. + + - `show_preview=true`: Allows requesters to enable the editor/preview experience. + - `show_preview=false`: Allows requesters to disable the editor/preview experience. + type: boolean + default: false + show_progress_stepper: + description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + type: boolean + default: true + signers: + description: Add Signers to your Templated-based Signature Request. + type: array + items: + $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: The URL you want signers redirected to after they successfully sign. + type: string + skip_me_now: + description: Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. + type: boolean + default: false + subject: + description: The subject in the email that will be sent to the signers. + type: string + maxLength: 255 + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.' + type: array + items: + type: string + test_mode: + description: 'Whether this is a test, the signature request created from this draft 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 + allow_ccs: + description: This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. + type: boolean + default: false + type: object + UnclaimedDraftEditAndResendRequest: + required: + - client_id + properties: + client_id: + description: Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. + type: string + editor_options: + $ref: '#/components/schemas/SubEditorOptions' + is_for_embedded_signing: + description: The request created from this draft will also be signable in embedded mode if set to `true`. + type: boolean + requester_email_address: + description: 'The email address of the user that should be designated as the requester of this draft. If not set, original requester''s email address will be used.' + type: string + format: email + requesting_redirect_url: + description: The URL you want signers redirected to after they successfully request a signature. + type: string + show_progress_stepper: + description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. + type: boolean + default: true + signing_redirect_url: + description: The URL you want signers redirected to after they successfully sign. + type: string + test_mode: + description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + type: object + AccountCreateResponse: + required: + - account + properties: + account: + $ref: '#/components/schemas/AccountResponse' + oauth_data: + $ref: '#/components/schemas/OAuthTokenResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + AccountGetResponse: + required: + - account + properties: + account: + $ref: '#/components/schemas/AccountResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + AccountVerifyResponse: + properties: + account: + $ref: '#/components/schemas/AccountVerifyResponseAccount' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + ApiAppGetResponse: + required: + - api_app + properties: + api_app: + $ref: '#/components/schemas/ApiAppResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + ApiAppListResponse: + required: + - api_apps + - list_info + properties: + api_apps: + description: Contains information about API Apps. + type: array + items: + $ref: '#/components/schemas/ApiAppResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + BulkSendJobGetResponse: + required: + - bulk_send_job + - list_info + - signature_requests + properties: + bulk_send_job: + $ref: '#/components/schemas/BulkSendJobResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + signature_requests: + description: Contains information about the Signature Requests sent in bulk. + type: array + items: + $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + BulkSendJobListResponse: + required: + - bulk_send_jobs + - list_info + properties: + bulk_send_jobs: + description: Contains a list of BulkSendJobs that the API caller has access to. + type: array + items: + $ref: '#/components/schemas/BulkSendJobResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + BulkSendJobSendResponse: + required: + - bulk_send_job + properties: + bulk_send_job: + $ref: '#/components/schemas/BulkSendJobResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + EmbeddedEditUrlResponse: + required: + - embedded + properties: + embedded: + $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + EmbeddedSignUrlResponse: + required: + - embedded + properties: + embedded: + $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + ErrorResponse: + required: + - error + properties: + error: + $ref: '#/components/schemas/ErrorResponseError' + type: object + FaxGetResponse: + required: + - fax + properties: + fax: + $ref: '#/components/schemas/FaxResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + FaxLineResponse: + required: + - fax_line + properties: + fax_line: + $ref: '#/components/schemas/FaxLineResponseFaxLine' + warnings: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + FaxLineAreaCodeGetResponse: + required: + - area_codes + properties: + area_codes: + type: array + items: + type: integer + type: object + x-internal-class: true + FaxLineListResponse: + required: + - fax_lines + - list_info + properties: + list_info: + $ref: '#/components/schemas/ListInfoResponse' + fax_lines: + type: array + items: + $ref: '#/components/schemas/FaxLineResponseFaxLine' + warnings: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + FaxListResponse: + required: + - faxes + - list_info + properties: + faxes: + type: array + items: + $ref: '#/components/schemas/FaxResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + type: object + x-internal-class: true + FileResponse: + required: + - file_url + - expires_at + properties: + file_url: + description: URL to the file. + type: string + expires_at: + description: When the link expires. + type: integer + type: object + x-internal-class: true + FileResponseDataUri: + required: + - data_uri + properties: + data_uri: + description: File as base64 encoded string. + type: string + type: object + x-internal-class: true + ReportCreateResponse: + required: + - report + properties: + report: + $ref: '#/components/schemas/ReportResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + SignatureRequestGetResponse: + required: + - signature_request + properties: + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + SignatureRequestListResponse: + required: + - signature_requests + - list_info + properties: + signature_requests: + description: Contains information about signature requests. + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + AccountResponse: + properties: + account_id: + description: The ID of the Account + type: string + email_address: + description: The email address associated with the Account. + type: string + is_locked: + description: Returns `true` if the user has been locked out of their account by a team admin. + type: boolean + is_paid_hs: + description: Returns `true` if the user has a paid Dropbox Sign account. + type: boolean + is_paid_hf: + description: Returns `true` if the user has a paid HelloFax account. + type: boolean + quotas: + $ref: '#/components/schemas/AccountResponseQuotas' + callback_url: + description: The URL that Dropbox Sign events will `POST` to. + type: string + nullable: true + role_code: + description: The membership role for the team. + type: string + nullable: true + team_id: + description: The id of the team account belongs to. + type: string + nullable: true + 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 + nullable: true + usage: + $ref: '#/components/schemas/AccountResponseUsage' + settings: + $ref: '#/components/schemas/AccountResponseSettings' + type: object + x-internal-class: true + OAuthTokenResponse: + properties: + access_token: + type: string + token_type: + type: string + refresh_token: + type: string + expires_in: + description: Number of seconds until the `access_token` expires. Uses epoch time. + type: integer + state: + type: string + nullable: true + type: object + x-internal-class: true + AccountResponseQuotas: + description: Details concerning remaining monthly quotas. + properties: + api_signature_requests_left: + description: API signature requests remaining. + type: integer + nullable: true + documents_left: + description: Signature requests remaining. + type: integer + nullable: true + templates_total: + description: Total API templates allowed. + type: integer + nullable: true + templates_left: + description: API templates remaining. + type: integer + nullable: true + sms_verifications_left: + description: SMS verifications remaining. + type: integer + nullable: true + num_fax_pages_left: + description: Number of fax pages left + type: integer + nullable: true + type: object + x-internal-class: true + AccountResponseSettings: + description: Subset of configured settings + properties: + signer_access_codes: + description: Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + type: boolean + sms_delivery: + description: Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + type: boolean + sms_authentication: + description: Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + type: boolean + type: object + x-internal-class: true + AccountResponseUsage: + description: Details concerning monthly usage + properties: + fax_pages_sent: + description: Number of fax pages sent + type: integer + nullable: true + type: object + x-internal-class: true + AccountVerifyResponseAccount: + properties: + email_address: + description: The email address associated with the Account. + type: string + type: object + x-internal-class: true + ApiAppResponse: + description: Contains information about an API App. + properties: + callback_url: + description: The app's callback URL (for events) + type: string + nullable: true + client_id: + description: The app's client id + type: string + created_at: + description: The time that the app was created + type: integer + domains: + description: The domain name(s) associated with the app + type: array + items: + type: string + name: + description: The name of the app + type: string + is_approved: + description: Boolean to indicate if the app has been approved + type: boolean + oauth: + $ref: '#/components/schemas/ApiAppResponseOAuth' + options: + $ref: '#/components/schemas/ApiAppResponseOptions' + owner_account: + $ref: '#/components/schemas/ApiAppResponseOwnerAccount' + white_labeling_options: + $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions' + type: object + x-internal-class: true + ApiAppResponseOAuth: + description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' + properties: + callback_url: + description: The app's OAuth callback URL. + type: string + secret: + description: 'The app''s OAuth secret, or null if the app does not belong to user.' + type: string + nullable: true + scopes: + description: Array of OAuth scopes used by the app. + type: array + items: + type: string + charges_users: + description: Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + type: boolean + type: object + nullable: true + x-internal-class: true + ApiAppResponseOptions: + description: An object with options that override account settings. + properties: + can_insert_everywhere: + description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' + type: boolean + type: object + nullable: true + x-internal-class: true + ApiAppResponseOwnerAccount: + description: An object describing the app's owner + properties: + account_id: + description: The owner account's ID + type: string + email_address: + description: The owner account's email address + type: string + type: object + x-internal-class: true + ApiAppResponseWhiteLabelingOptions: + description: An object with options to customize the app's signer page + properties: + header_background_color: + type: string + legal_version: + type: string + link_color: + type: string + page_background_color: + type: string + primary_button_color: + type: string + primary_button_color_hover: + type: string + primary_button_text_color: + type: string + primary_button_text_color_hover: + type: string + secondary_button_color: + type: string + secondary_button_color_hover: + type: string + secondary_button_text_color: + type: string + secondary_button_text_color_hover: + type: string + text_color1: + type: string + text_color2: + type: string + type: object + nullable: true + x-internal-class: true + BulkSendJobResponse: + description: Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + properties: + bulk_send_job_id: + description: The id of the BulkSendJob. + type: string + nullable: true + total: + description: The total amount of Signature Requests queued for sending. + type: integer + is_creator: + description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.' + type: boolean + created_at: + description: Time that the BulkSendJob was created. + type: integer + type: object + x-internal-class: true + BulkSendJobGetResponseSignatureRequests: + title: BulkSendJobGetResponseSignatureRequests + type: object + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponse' + - properties: + bulk_send_job_id: + description: The id of the BulkSendJob. + type: string + metadata: + description: The metadata attached to the signature request. + type: object + additionalProperties: {} + x-internal-class: true + EmbeddedEditUrlResponseEmbedded: + description: An embedded template object. + properties: + edit_url: + description: A template url that can be opened in an iFrame. + type: string + expires_at: + description: 'The specific time that the the `edit_url` link expires, in epoch.' + type: integer + type: object + x-internal-class: true + EmbeddedSignUrlResponseEmbedded: + description: An object that contains necessary information to set up embedded signing. + properties: + sign_url: + description: A signature url that can be opened in an iFrame. + type: string + expires_at: + description: 'The specific time that the the `sign_url` link expires, in epoch.' + type: integer + type: object + x-internal-class: true + ErrorResponseError: + description: Contains information about an error that occurred. + required: + - error_msg + - error_name + properties: + error_msg: + description: Message describing an error. + type: string + error_path: + description: Path at which an error occurred. + type: string + error_name: + description: 'Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.' + type: string + type: object + FaxResponse: + required: + - fax_id + - title + - original_title + - metadata + - created_at + - sender + - files_url + - transmissions + properties: + fax_id: + description: Fax ID + type: string + title: + description: Fax Title + type: string + original_title: + description: Fax Original Title + type: string + subject: + description: Fax Subject + type: string + nullable: true + message: + description: Fax Message + type: string + nullable: true + metadata: + description: Fax Metadata + type: object + additionalProperties: {} + created_at: + description: Fax Created At Timestamp + type: integer + sender: + description: Fax Sender Email + type: string + files_url: + description: Fax Files URL + type: string + final_copy_uri: + description: The path where the completed document can be downloaded + type: string + nullable: true + transmissions: + description: Fax Transmissions List + type: array + items: + $ref: '#/components/schemas/FaxResponseTransmission' + type: object + x-internal-class: true + FaxLineResponseFaxLine: + properties: + number: + description: Number + type: string + created_at: + description: Created at + type: integer + updated_at: + description: Updated at + type: integer + accounts: + type: array + items: + $ref: '#/components/schemas/AccountResponse' + type: object + x-internal-class: true + FaxResponseTransmission: + required: + - recipient + - status_code + properties: + recipient: + description: Fax Transmission Recipient + type: string + status_code: + description: Fax Transmission Status Code + type: string + enum: + - success + - transmitting + - error_could_not_fax + - error_unknown + - error_busy + - error_no_answer + - error_disconnected + - error_bad_destination + sent_at: + description: Fax Transmission Sent Timestamp + type: integer + type: object + x-internal-class: true + ListInfoResponse: + description: Contains pagination information about the data returned. + properties: + num_pages: + description: Total number of pages available. + type: integer + num_results: + description: Total number of objects available. + type: integer + nullable: true + page: + description: Number of the page being returned. + type: integer + page_size: + description: Objects returned per page. + type: integer + type: object + x-internal-class: true + ReportResponse: + description: Contains information about the report request. + properties: + success: + description: A message indicating the requested operation's success + type: string + start_date: + description: The (inclusive) start date for the report data in MM/DD/YYYY format. + type: string + 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: + enum: + - user_activity + - document_status + - sms_activity + - fax_usage + type: object + x-internal-class: true + SignatureRequestResponse: + description: Contains information about a signature request. + properties: + test_mode: + description: Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + type: boolean + default: false + signature_request_id: + description: The id of the SignatureRequest. + type: string + requester_email_address: + description: The email address of the initiator of the SignatureRequest. + type: string + nullable: true + title: + description: The title the specified Account uses for the SignatureRequest. + type: string + original_title: + description: Default Label for account. + type: string + subject: + description: The subject in the email that was initially sent to the signers. + type: string + nullable: true + message: + description: The custom message in the email that was initially sent to the signers. + type: string + nullable: true + metadata: + description: The metadata attached to the signature request. + type: object + additionalProperties: {} + created_at: + description: Time the signature request was created. + type: integer + expires_at: + description: The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + type: integer + nullable: true + is_complete: + description: Whether or not the SignatureRequest has been fully executed by all signers. + type: boolean + is_declined: + description: Whether or not the SignatureRequest has been declined by a signer. + type: boolean + has_error: + description: Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + type: boolean + files_url: + description: The URL where a copy of the request's documents can be downloaded. + type: string + signing_url: + description: 'The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.' + type: string + nullable: true + details_url: + description: The URL where the requester and the signers can view the current status of the SignatureRequest. + type: string + cc_email_addresses: + description: A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + type: array + items: + type: string + signing_redirect_url: + description: The URL you want the signer redirected to after they successfully sign. + type: string + nullable: true + final_copy_uri: + description: The path where the completed document can be downloaded + type: string + nullable: true + template_ids: + description: Templates IDs used in this SignatureRequest (if any). + type: array + items: + type: string + nullable: true + custom_fields: + description: |- + An array of Custom Field objects containing the name and type of each custom field. + + * Text Field uses `SignatureRequestResponseCustomFieldText` + * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' + nullable: true + attachments: + description: Signer attachments. + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' + nullable: true + response_data: + description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + nullable: true + signatures: + description: 'An array of signature objects, 1 for each signer.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseSignatures' + bulk_send_job_id: + description: 'The ID of the Bulk Send job which sent the signature request, if applicable.' + type: string + nullable: true + type: object + x-internal-class: true + SignatureRequestResponseAttachment: + description: Signer attachments. + required: + - id + - signer + - name + - required + properties: + id: + description: The unique ID for this attachment. + type: string + signer: + description: The Signer this attachment is assigned to. + type: string + x-int-or-string: true + name: + description: The name of this attachment. + type: string + required: + description: A boolean value denoting if this attachment is required. + type: boolean + instructions: + description: Instructions for Signer. + type: string + nullable: true + uploaded_at: + description: Timestamp when attachment was uploaded by Signer. + type: integer + nullable: true + type: object + x-internal-class: true + SignatureRequestResponseCustomFieldBase: + description: |- + An array of Custom Field objects containing the name and type of each custom field. + + * Text Field uses `SignatureRequestResponseCustomFieldText` + * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + required: + - name + - type + properties: + type: + description: The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + type: string + name: + description: The name of the Custom Field. + type: string + required: + description: A boolean value denoting if this field is required. + type: boolean + api_id: + description: The unique ID for this field. + type: string + editor: + description: The name of the Role that is able to edit this field. + type: string + nullable: true + type: object + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/SignatureRequestResponseCustomFieldText' + checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox' + x-internal-class: true + x-base-class: true + SignatureRequestResponseCustomFieldCheckbox: + description: This class extends `SignatureRequestResponseCustomFieldBase`. + required: + - type + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' + - properties: + type: + description: The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + type: string + default: checkbox + value: + description: A true/false for checkbox fields + type: boolean + type: object + SignatureRequestResponseCustomFieldText: + description: This class extends `SignatureRequestResponseCustomFieldBase`. + required: + - type + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' + - properties: + type: + description: The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + type: string + default: text + value: + description: A text string for text fields + type: string + type: object + SignatureRequestResponseCustomFieldTypeEnum: + type: string + enum: + - text + - checkbox + SignatureRequestResponseDataBase: + description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' + properties: + api_id: + description: The unique ID for this field. + type: string + signature_id: + description: The ID of the signature to which this response is linked. + type: string + name: + description: The name of the form field. + type: string + required: + description: A boolean value denoting if this field is required. + type: boolean + type: + type: string + type: object + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/SignatureRequestResponseDataValueText' + checkbox: '#/components/schemas/SignatureRequestResponseDataValueCheckbox' + dropdown: '#/components/schemas/SignatureRequestResponseDataValueDropdown' + radio: '#/components/schemas/SignatureRequestResponseDataValueRadio' + signature: '#/components/schemas/SignatureRequestResponseDataValueSignature' + date_signed: '#/components/schemas/SignatureRequestResponseDataValueDateSigned' + initials: '#/components/schemas/SignatureRequestResponseDataValueInitials' + text-merge: '#/components/schemas/SignatureRequestResponseDataValueTextMerge' + checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge' + x-internal-class: true + x-base-class: true + SignatureRequestResponseDataTypeEnum: + type: string + enum: + - text + - checkbox + - date_signed + - dropdown + - initials + - radio + - signature + - text-merge + - checkbox-merge + SignatureRequestResponseDataValueCheckbox: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: A yes/no checkbox + type: string + default: checkbox + value: + description: The value of the form field. + type: boolean + type: object + SignatureRequestResponseDataValueCheckboxMerge: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: A checkbox field that has default value set by the api + type: string + default: checkbox-merge + value: + description: The value of the form field. + type: string + type: object + SignatureRequestResponseDataValueDateSigned: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: A date + type: string + default: date_signed + value: + description: The value of the form field. + type: string + type: object + SignatureRequestResponseDataValueDropdown: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: An input field for dropdowns + type: string + default: dropdown + value: + description: The value of the form field. + type: string + type: object + SignatureRequestResponseDataValueInitials: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: An input field for initials + type: string + default: initials + value: + description: The value of the form field. + type: string + is_signed: + description: This field contains the boolean true if the field is signed. + type: boolean + nullable: true + type: object + SignatureRequestResponseDataValueRadio: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: An input field for radios + type: string + default: radio + value: + description: The value of the form field. + type: boolean + type: object + SignatureRequestResponseDataValueSignature: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: A signature input field + type: string + default: signature + value: + description: The value of the form field. + type: string + is_signed: + description: This field contains the boolean true if the field is signed. + type: boolean + nullable: true + type: object + SignatureRequestResponseDataValueText: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: A text input field + type: string + default: text + value: + description: The value of the form field. + type: string + type: object + SignatureRequestResponseDataValueTextMerge: + allOf: + - + $ref: '#/components/schemas/SignatureRequestResponseDataBase' + - properties: + type: + description: A text field that has default text set by the api + type: string + default: text-merge + value: + description: The value of the form field. + type: string + type: object + SignatureRequestResponseSignatures: + description: 'An array of signature objects, 1 for each signer.' + properties: + signature_id: + description: Signature identifier. + type: string + signer_group_guid: + description: Signer Group GUID + type: string + nullable: true + signer_email_address: + description: The email address of the signer. + type: string + signer_name: + description: The name of the signer. + type: string + nullable: true + signer_role: + description: The role of the signer. + type: string + nullable: true + order: + description: If signer order is assigned this is the 0-based index for this signer. + type: integer + nullable: true + status_code: + description: 'The current status of the signature. eg: awaiting_signature, signed, declined.' + type: string + decline_reason: + description: The reason provided by the signer for declining the request. + type: string + nullable: true + signed_at: + description: Time that the document was signed or null. + type: integer + nullable: true + last_viewed_at: + description: The time that the document was last viewed by this signer or null. + type: integer + nullable: true + last_reminded_at: + description: The time the last reminder email was sent to the signer or null. + type: integer + nullable: true + has_pin: + description: Boolean to indicate whether this signature requires a PIN to access. + type: boolean + has_sms_auth: + description: Boolean to indicate whether this signature has SMS authentication enabled. + type: boolean + nullable: true + has_sms_delivery: + description: Boolean to indicate whether this signature has SMS delivery enabled. + type: boolean + nullable: true + sms_phone_number: + description: The SMS phone number used for authentication or signature request delivery. + type: string + nullable: true + reassigned_by: + description: Email address of original signer who reassigned to this signer. + type: string + nullable: true + reassignment_reason: + description: Reason provided by original signer who reassigned to this signer. + type: string + nullable: true + reassigned_from: + description: Previous signature identifier. + type: string + nullable: true + error: + description: 'Error message pertaining to this signer, or null.' + type: string + nullable: true + type: object + x-internal-class: true + SignatureRequestSignerExperience: + description: Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + required: + - form_view + type: object + x-internal-class: true + TeamResponse: + description: Contains information about your team and its members + properties: + name: + description: The name of your Team + type: string + accounts: + type: array + items: + $ref: '#/components/schemas/AccountResponse' + invited_accounts: + description: A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. + type: array + items: + $ref: '#/components/schemas/AccountResponse' + invited_emails: + description: A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + type: array + items: + type: string + type: object + x-internal-class: true + TeamInfoResponse: + properties: + team_id: + description: The id of a team + type: string + team_parent: + $ref: '#/components/schemas/TeamParentResponse' + name: + description: The name of a team + type: string + num_members: + description: Number of members within a team + type: integer + num_sub_teams: + description: Number of sub teams within a team + type: integer + type: object + x-internal-class: true + TeamInviteResponse: + properties: + email_address: + description: Email address of the user invited to this team. + type: string + team_id: + description: Id of the team. + type: string + role: + description: Role of the user invited to this team. + type: string + sent_at: + description: Timestamp when the invitation was sent. + type: integer + redeemed_at: + description: Timestamp when the invitation was redeemed. + type: integer + expires_at: + description: Timestamp when the invitation is expiring. + type: integer + type: object + x-internal-class: true + TeamMemberResponse: + properties: + account_id: + description: Account id of the team member. + type: string + email_address: + description: Email address of the team member. + type: string + role: + description: The specific role a member has on the team. + type: string + type: object + x-internal-class: true + TeamParentResponse: + description: 'Information about the parent team if a team has one, set to `null` otherwise.' + properties: + team_id: + description: The id of a team + type: string + name: + description: The name of a team + type: string + type: object + nullable: true + x-internal-class: true + SubTeamResponse: + properties: + team_id: + description: The id of a team + type: string + name: + description: The name of a team + type: string + type: object + x-internal-class: true + TemplateResponse: + description: Contains information about the templates you and your team have created. + properties: + template_id: + description: The id of the Template. + type: string + title: + description: The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + type: string + message: + description: The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + type: string + updated_at: + description: Time the template was last updated. + type: integer + is_embedded: + description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' + type: boolean + nullable: true + is_creator: + description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' + type: boolean + can_edit: + description: Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). + type: boolean + is_locked: + description: |- + Indicates whether the template is locked. + If `true`, then the template was created outside your quota and can only be used in `test_mode`. + If `false`, then the template is within your quota and can be used to create signature requests. + type: boolean + metadata: + description: The metadata attached to the template. + type: object + additionalProperties: {} + signer_roles: + description: An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + type: array + items: + $ref: '#/components/schemas/TemplateResponseSignerRole' + cc_roles: + description: An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + type: array + items: + $ref: '#/components/schemas/TemplateResponseCCRole' + documents: + description: An array describing each document associated with this Template. Includes form field data for each document. + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocument' + custom_fields: + description: Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' + nullable: true + deprecated: true + named_form_fields: + description: Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + nullable: true + deprecated: true + accounts: + description: An array of the Accounts that can use this Template. + type: array + items: + $ref: '#/components/schemas/TemplateResponseAccount' + attachments: + description: Signer attachments. + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' + type: object + x-internal-class: true + TemplateResponseAccount: + properties: + account_id: + description: The id of the Account. + type: string + email_address: + description: The email address associated with the Account. + type: string + is_locked: + description: Returns `true` if the user has been locked out of their account by a team admin. + type: boolean + is_paid_hs: + description: Returns `true` if the user has a paid Dropbox Sign account. + type: boolean + is_paid_hf: + description: Returns `true` if the user has a paid HelloFax account. + type: boolean + quotas: + $ref: '#/components/schemas/TemplateResponseAccountQuota' + type: object + x-internal-class: true + TemplateResponseAccountQuota: + description: An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + properties: + templates_left: + description: API templates remaining. + type: integer + api_signature_requests_left: + description: API signature requests remaining. + type: integer + documents_left: + description: Signature requests remaining. + type: integer + sms_verifications_left: + description: SMS verifications remaining. + type: integer + type: object + x-internal-class: true + TemplateResponseCCRole: + properties: + name: + description: The name of the Role. + type: string + type: object + x-internal-class: true + TemplateCreateEmbeddedDraftResponseTemplate: + description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + properties: + template_id: + description: The id of the Template. + type: string + edit_url: + description: Link to edit the template. + type: string + expires_at: + description: When the link expires. + type: integer + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + deprecated: true + type: object + x-internal-class: true + TemplateCreateResponseTemplate: + description: 'Template object with parameters: `template_id`.' + properties: + template_id: + description: The id of the Template. + type: string + type: object + x-internal-class: true + TemplateResponseDocument: + properties: + name: + description: Name of the associated file. + type: string + index: + description: Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + type: integer + field_groups: + description: An array of Form Field Group objects. + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup' + form_fields: + description: An array of Form Field objects containing the name and type of each named field. + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + custom_fields: + description: An array of Form Field objects containing the name and type of each named field. + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' + static_fields: + description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' + type: array + items: + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + type: object + x-internal-class: true + TemplateResponseDocumentCustomFieldBase: + description: An array of Form Field objects containing the name and type of each named field. + required: + - type + properties: + api_id: + description: The unique ID for this field. + type: string + name: + description: The name of the Custom Field. + type: string + type: + type: string + signer: + description: The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + type: string + nullable: true + x-int-or-string: true + x: + description: The horizontal offset in pixels for this form field. + type: integer + 'y': + description: The vertical offset in pixels for this form field. + type: integer + width: + description: The width in pixels of this form field. + type: integer + height: + description: The height in pixels of this form field. + type: integer + required: + description: Boolean showing whether or not this field is required. + type: boolean + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' + type: string + nullable: true + type: object + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/TemplateResponseDocumentCustomFieldText' + checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox' + x-internal-class: true + x-base-class: true + TemplateResponseDocumentCustomFieldCheckbox: + description: This class extends `TemplateResponseDocumentCustomFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' + - properties: + type: + description: |- + The type of this Custom Field. Only `text` and `checkbox` are currently supported. + + * Text uses `TemplateResponseDocumentCustomFieldText` + * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + type: string + default: checkbox + type: object + TemplateResponseDocumentCustomFieldText: + description: This class extends `TemplateResponseDocumentCustomFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' + - properties: + type: + description: |- + The type of this Custom Field. Only `text` and `checkbox` are currently supported. + + * Text uses `TemplateResponseDocumentCustomFieldText` + * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + type: string + default: text + avg_text_length: + $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' + isMultiline: + description: Whether this form field is multiline text. + type: boolean + originalFontSize: + description: Original font size used in this form field's text. + type: integer + fontFamily: + description: Font family used in this form field's text. + type: string + type: object + TemplateResponseDocumentFieldGroup: + properties: + name: + description: The name of the form field group. + type: string + rule: + $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule' + type: object + x-internal-class: true + TemplateResponseDocumentFieldGroupRule: + description: The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + properties: + requirement: + description: |- + Examples: `require_0-1` `require_1` `require_1-ormore` + + - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). + - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). + - Radio groups require **at least** two fields per group. + type: string + groupLabel: + description: Name of the group + type: string + type: object + x-internal-class: true + TemplateResponseDocumentFormFieldBase: + description: An array of Form Field objects containing the name and type of each named field. + required: + - type + properties: + api_id: + description: A unique id for the form field. + type: string + name: + description: The name of the form field. + type: string + type: + type: string + signer: + description: The signer of the Form Field. + type: string + x-int-or-string: true + x: + description: The horizontal offset in pixels for this form field. + type: integer + 'y': + description: The vertical offset in pixels for this form field. + type: integer + width: + description: The width in pixels of this form field. + type: integer + height: + description: The height in pixels of this form field. + type: integer + required: + description: Boolean showing whether or not this field is required. + type: boolean + type: object + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/TemplateResponseDocumentFormFieldText' + dropdown: '#/components/schemas/TemplateResponseDocumentFormFieldDropdown' + hyperlink: '#/components/schemas/TemplateResponseDocumentFormFieldHyperlink' + checkbox: '#/components/schemas/TemplateResponseDocumentFormFieldCheckbox' + radio: '#/components/schemas/TemplateResponseDocumentFormFieldRadio' + signature: '#/components/schemas/TemplateResponseDocumentFormFieldSignature' + date_signed: '#/components/schemas/TemplateResponseDocumentFormFieldDateSigned' + initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials' + x-internal-class: true + x-base-class: true + TemplateResponseDocumentFormFieldCheckbox: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: checkbox + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentFormFieldDateSigned: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: date_signed + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentFormFieldDropdown: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: dropdown + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentFormFieldHyperlink: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: hyperlink + avg_text_length: + $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' + isMultiline: + description: Whether this form field is multiline text. + type: boolean + originalFontSize: + description: Original font size used in this form field's text. + type: integer + fontFamily: + description: Font family used in this form field's text. + type: string + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentFormFieldInitials: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: initials + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentFormFieldRadio: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + - group + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: radio + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + type: object + TemplateResponseDocumentFormFieldSignature: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: signature + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentFormFieldText: + description: This class extends `TemplateResponseDocumentFormFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' + - properties: + type: + description: |- + The type of this form field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentFormFieldText` + * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentFormFieldRadio` + * Signature Field uses `TemplateResponseDocumentFormFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + type: string + default: text + avg_text_length: + $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' + isMultiline: + description: Whether this form field is multiline text. + type: boolean + originalFontSize: + description: Original font size used in this form field's text. + type: integer + fontFamily: + description: Font family used in this form field's text. + type: string + validation_type: + description: Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + type: string + enum: + - numbers_only + - letters_only + - phone_number + - bank_routing_number + - bank_account_number + - email_address + - zip_code + - social_security_number + - employer_identification_number + - custom_regex + nullable: true + validation_custom_regex: + description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.' + type: string + nullable: true + validation_custom_regex_format_label: + description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.' + type: string + nullable: true + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true + type: object + TemplateResponseDocumentStaticFieldBase: + description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' + required: + - type + properties: + api_id: + description: A unique id for the static field. + type: string + name: + description: The name of the static field. + type: string + type: + type: string + signer: + description: The signer of the Static Field. + type: string + default: me_now + x: + description: The horizontal offset in pixels for this static field. + type: integer + 'y': + description: The vertical offset in pixels for this static field. + type: integer + width: + description: The width in pixels of this static field. + type: integer + height: + description: The height in pixels of this static field. + type: integer + required: + description: Boolean showing whether or not this field is required. + type: boolean + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' + type: string + nullable: true + type: object + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/TemplateResponseDocumentStaticFieldText' + dropdown: '#/components/schemas/TemplateResponseDocumentStaticFieldDropdown' + hyperlink: '#/components/schemas/TemplateResponseDocumentStaticFieldHyperlink' + checkbox: '#/components/schemas/TemplateResponseDocumentStaticFieldCheckbox' + radio: '#/components/schemas/TemplateResponseDocumentStaticFieldRadio' + signature: '#/components/schemas/TemplateResponseDocumentStaticFieldSignature' + date_signed: '#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned' + initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials' + x-internal-class: true + x-base-class: true + TemplateResponseDocumentStaticFieldCheckbox: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: checkbox + type: object + TemplateResponseDocumentStaticFieldDateSigned: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: date_signed + type: object + TemplateResponseDocumentStaticFieldDropdown: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: dropdown + type: object + TemplateResponseDocumentStaticFieldHyperlink: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: hyperlink + type: object + TemplateResponseDocumentStaticFieldInitials: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: initials + type: object + TemplateResponseDocumentStaticFieldRadio: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: radio + type: object + TemplateResponseDocumentStaticFieldSignature: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: signature + type: object + TemplateResponseDocumentStaticFieldText: + description: This class extends `TemplateResponseDocumentStaticFieldBase` + required: + - type + allOf: + - + $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' + - properties: + type: + description: |- + The type of this static field. See [field types](/api/reference/constants/#field-types). + + * Text Field uses `TemplateResponseDocumentStaticFieldText` + * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` + * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` + * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` + * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` + * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` + * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` + * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + type: string + default: text + type: object + TemplateResponseFieldAvgTextLength: + description: Average text length in this field. + properties: + num_lines: + description: Number of lines. + type: integer + num_chars_per_line: + description: Number of characters per line. + type: integer + type: object + x-internal-class: true + TemplateResponseSignerRole: + properties: + name: + description: The name of the Role. + type: string + order: + description: If signer order is assigned this is the 0-based index for this role. + type: integer + type: object + x-internal-class: true + TemplateUpdateFilesResponseTemplate: + description: Contains template id + properties: + template_id: + description: The id of the Template. + type: string + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + deprecated: true + type: object + x-internal-class: true + UnclaimedDraftResponse: + description: A group of documents that a user can take ownership of via the claim URL. + properties: + signature_request_id: + description: The ID of the signature request that is represented by this UnclaimedDraft. + type: string + nullable: true + claim_url: + description: The URL to be used to claim this UnclaimedDraft. + type: string + signing_redirect_url: + description: The URL you want signers redirected to after they successfully sign. + type: string + nullable: true + requesting_redirect_url: + description: The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + type: string + nullable: true + expires_at: + description: When the link expires. + type: integer + nullable: true + test_mode: + description: Whether this is a test draft. Signature requests made from test drafts have no legal value. + type: boolean + type: object + x-internal-class: true + WarningResponse: + description: A list of warnings. + required: + - warning_msg + - warning_name + properties: + warning_msg: + description: Warning message + type: string + warning_name: + description: Warning name + type: string + type: object + TeamGetResponse: + required: + - team + properties: + team: + $ref: '#/components/schemas/TeamResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TeamGetInfoResponse: + required: + - team + properties: + team: + $ref: '#/components/schemas/TeamInfoResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TeamInvitesResponse: + required: + - team_invites + properties: + team_invites: + description: Contains a list of team invites and their roles. + type: array + items: + $ref: '#/components/schemas/TeamInviteResponse' + warnings: + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TeamMembersResponse: + required: + - team_members + - list_info + properties: + team_members: + description: Contains a list of team members and their roles for a specific team. + type: array + items: + $ref: '#/components/schemas/TeamMemberResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + warnings: + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TeamSubTeamsResponse: + required: + - sub_teams + - list_info + properties: + sub_teams: + description: Contains a list with sub teams. + type: array + items: + $ref: '#/components/schemas/SubTeamResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + warnings: + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TemplateCreateResponse: + required: + - template + properties: + template: + $ref: '#/components/schemas/TemplateCreateResponseTemplate' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TemplateCreateEmbeddedDraftResponse: + required: + - template + properties: + template: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TemplateGetResponse: + required: + - template + properties: + template: + $ref: '#/components/schemas/TemplateResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TemplateListResponse: + required: + - templates + - list_info + properties: + templates: + description: List of templates that the API caller has access to. + type: array + items: + $ref: '#/components/schemas/TemplateResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + TemplateUpdateFilesResponse: + required: + - template + properties: + template: + $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate' + type: object + x-internal-class: true + UnclaimedDraftCreateResponse: + required: + - unclaimed_draft + properties: + unclaimed_draft: + $ref: '#/components/schemas/UnclaimedDraftResponse' + warnings: + description: A list of warnings. + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true + EventCallbackRequest: + title: EventCallbackRequest + required: + - event + properties: + event: + $ref: '#/components/schemas/EventCallbackRequestEvent' + account: + $ref: '#/components/schemas/AccountResponse' + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + template: + $ref: '#/components/schemas/TemplateResponse' + type: object + x-fern-audiences: + - events + EventCallbackRequestEvent: + description: Basic information about the event that occurred. + required: + - event_time + - event_type + - event_hash + properties: + event_time: + description: Time the event was created (using Unix time). + type: string + event_type: + description: Type of callback event that was triggered. + type: string + enum: + - account_confirmed + - unknown_error + - file_error + - sign_url_invalid + - signature_request_viewed + - signature_request_signed + - signature_request_sent + - signature_request_all_signed + - signature_request_email_bounce + - signature_request_remind + - signature_request_incomplete_qes + - signature_request_destroyed + - signature_request_canceled + - signature_request_downloadable + - signature_request_declined + - signature_request_reassigned + - signature_request_invalid + - signature_request_prepared + - signature_request_expired + - template_created + - template_error + - callback_test + - signature_request_signer_removed + event_hash: + description: Generated hash used to verify source of event data. + type: string + event_metadata: + $ref: '#/components/schemas/EventCallbackRequestEventMetadata' + type: object + x-fern-audiences: + - events + EventCallbackRequestEventMetadata: + description: Specific metadata about the event. + properties: + related_signature_id: + description: Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + type: string + nullable: true + reported_for_account_id: + description: Account ID the event was reported for. + type: string + nullable: true + reported_for_app_id: + description: App ID the event was reported for. + type: string + nullable: true + event_message: + description: Message about a declined or failed (due to error) signature flow. + type: string + nullable: true + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestViewed: + title: Signature Request Viewed Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_viewed + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestSigned: + title: Signature Request Signed Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_signed + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestSignerRemoved: + title: Signature Request Signer Removed Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_signer_removed + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestDownloadable: + title: Signature Request Downloadable Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_downloadable + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestSent: + title: Signature Request Sent Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_sent + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestAllSigned: + title: Signature Request All Signed Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_all_signed + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestInvalid: + title: Signature Request Invalid Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_invalid + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestEmailBounce: + title: Signature Request Email Bounce Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_email_bounce + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestRemind: + title: Signature Request Remind Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_remind + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestIncompleteQes: + title: Signature Request Incomplete QES Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_incomplete_qes + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestDestroyed: + title: Signature Request Destroyed Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_destroyed + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestCanceled: + title: Signature Request Canceled Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_canceled + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestDeclined: + title: Signature Request Declined Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_declined + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestExpired: + title: Signature Request Expired Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_expired + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestReassigned: + title: Signature Request Reassigned Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_reassigned + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignatureRequestPrepared: + title: Signature Request Prepared Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - signature_request_prepared + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackAccountConfirmed: + title: Account Confirmed Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - account_confirmed + type: object + account: + $ref: '#/components/schemas/AccountResponse' + type: object + x-fern-audiences: + - events + EventCallbackUnknownError: + title: Unknown Error Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - unknown_error + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFileError: + title: File Error Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - file_error + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackTemplateCreated: + title: Template Created Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - template_created + type: object + template: + $ref: '#/components/schemas/TemplateResponse' + type: object + x-fern-audiences: + - events + EventCallbackTemplateError: + title: Template Error Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - template_error + type: object + template: + $ref: '#/components/schemas/TemplateResponse' + type: object + x-fern-audiences: + - events + EventCallbackSignUrlInvalid: + title: Sign URL Invalid Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - sign_url_invalid + type: object + signature_request: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackCallbackTest: + title: Callback Test Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - callback_test + type: object + type: object + x-fern-audiences: + - events + EventCallbackPayload: + title: Event Callback Payload + description: JSON payload delivered for a webhook event. The concrete shape is selected by `event.event_type`. + oneOf: + - + $ref: '#/components/schemas/EventCallbackSignatureRequestViewed' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestSigned' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestSignerRemoved' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestDownloadable' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestSent' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestAllSigned' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestInvalid' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestEmailBounce' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestRemind' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestIncompleteQes' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestDestroyed' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestCanceled' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestDeclined' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestExpired' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestReassigned' + - + $ref: '#/components/schemas/EventCallbackSignatureRequestPrepared' + - + $ref: '#/components/schemas/EventCallbackAccountConfirmed' + - + $ref: '#/components/schemas/EventCallbackUnknownError' + - + $ref: '#/components/schemas/EventCallbackFileError' + - + $ref: '#/components/schemas/EventCallbackTemplateCreated' + - + $ref: '#/components/schemas/EventCallbackTemplateError' + - + $ref: '#/components/schemas/EventCallbackSignUrlInvalid' + - + $ref: '#/components/schemas/EventCallbackCallbackTest' + x-fern-audiences: + - events + responses: + EventCallbackResponse: + description: successful operation + content: + text/plain: + schema: + type: string + default: Hello API Event Received + x-fern-audiences: + - events + examples: + AccountCreateRequest: + summary: Default Example + value: + email_address: newuser@dropboxsign.com + AccountCreateRequestOAuth: + summary: OAuth Example + value: + email_address: newuser@dropboxsign.com + client_id: cc91c61d00f8bb2ece1428035716b + client_secret: 1d14434088507ffa390e6f5528465 + AccountUpdateRequest: + summary: Default Example + value: + callback_url: https://www.example.com/callback + locale: en-US + AccountVerifyRequest: + summary: Default Example + value: + email_address: some_user@dropboxsign.com + ApiAppCreateRequest: + summary: Default Example + value: + name: My Production App + 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' + ApiAppUpdateRequest: + summary: Default Example + value: + 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' + EmbeddedEditUrlRequest: + summary: Default Example + value: + cc_roles: + - '' + merge_fields: [] + FaxLineAddUserRequest: + summary: Default Example + value: + number: '[FAX_NUMBER]' + email_address: member@dropboxsign.com + FaxLineCreateRequest: + summary: Default Example + value: + area_code: 209 + country: US + FaxLineDeleteRequest: + summary: Default Example + value: + number: '[FAX_NUMBER]' + FaxLineRemoveUserRequest: + summary: Default Example + value: + number: '[FAX_NUMBER]' + email_address: member@dropboxsign.com + FaxSendRequest: + summary: Default Example + value: + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + test_mode: 'true' + recipient: '16690000001' + sender: '16690000000' + cover_page_to: Jill Fax + cover_page_message: 'I''m sending you a fax!' + cover_page_from: Faxer Faxerson + title: 'This is what the fax is about!' + OAuthTokenGenerateRequest: + summary: OAuth Token Generate Example + value: + state: 900e06e2 + code: 1b0d28d90c86c141 + grant_type: authorization_code + client_id: cc91c61d00f8bb2ece1428035716b + client_secret: 1d14434088507ffa390e6f5528465 + OAuthTokenRefreshRequest: + summary: OAuth Token Refresh Example + value: + grant_type: refresh_token + refresh_token: hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3 + ReportCreateRequest: + summary: Default Example + value: + start_date: 09/01/2020 + end_date: 09/01/2020 + report_type: + - user_activity + - document_status + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + summary: Default Example + value: + client_id: 1a659d9ad95bccd307ecad78d72192f8 + template_ids: + - c26b8a16784a872da37ea946b9ddec7c1e11dff6 + subject: Purchase Order + message: Glad we could come to an agreement. + signer_list: + - signers: + - role: Client + name: George + email_address: george@example.com + pin: d79a3td + custom_fields: + - name: company + value: ABC Corp + - signers: + - role: Client + name: Mary + email_address: mary@example.com + pin: gd9as5b + custom_fields: + - name: company + value: 123 LLC + ccs: + - role: Accounting + email_address: accounting@example.com + test_mode: true + SignatureRequestBulkSendWithTemplateRequest: + summary: Default Example + value: + template_ids: + - c26b8a16784a872da37ea946b9ddec7c1e11dff6 + subject: Purchase Order + message: Glad we could come to an agreement. + signer_list: + - signers: + - role: Client + name: George + email_address: george@example.com + pin: d79a3td + custom_fields: + - name: company + value: ABC Corp + - signers: + - role: Client + name: Mary + email_address: mary@example.com + pin: gd9as5b + custom_fields: + - name: company + value: 123 LLC + ccs: + - role: Accounting + email_address: accounting@example.com + test_mode: true + SignatureRequestCreateEmbeddedRequest: + summary: Default Example + value: + 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 + have 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 + force_advanced_signature_details: false + test_mode: true + SignatureRequestCreateEmbeddedRequestGroupedSigners: + summary: Grouped Signers Example + value: + 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 + have 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 + SignatureRequestCreateEmbeddedWithTemplateRequest: + summary: Default Example + value: + 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 + force_advanced_signature_details: false + test_mode: true + SignatureRequestEditRequest: + summary: Default Example + value: + 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: + - 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 + SignatureRequestEditRequestGroupedSigners: + summary: Grouped Signers Example + value: + 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. + 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 + SignatureRequestEditEmbeddedRequest: + summary: Default Example + value: + 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 + have 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 + SignatureRequestEditEmbeddedRequestGroupedSigners: + summary: Grouped Signers Example + value: + 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 + have 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 + SignatureRequestEditEmbeddedWithTemplateRequest: + summary: Default Example + value: + 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 + SignatureRequestEditWithTemplateRequest: + summary: Default Example + value: + 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 + SignatureRequestRemindRequest: + summary: Default Example + value: + email_address: john@example.com + SignatureRequestSendRequest: + summary: Default Example + value: + 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: + - 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 + force_advanced_signature_details: false + field_options: + date_format: DD - MM - YYYY + test_mode: true + SignatureRequestSendRequestGroupedSigners: + summary: Grouped Signers Example + value: + 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. + 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 + SignatureRequestSendWithTemplateRequest: + summary: Default Example + value: + 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 + force_advanced_signature_details: false + test_mode: true + SignatureRequestUpdateRequest: + summary: Default Example + value: + email_address: john@example.com + signature_id: 2f9781e1a8e2045224d808c153c2e1d3df6f8f2f + TeamAddMemberRequest: + summary: Email Address Example + value: + email_address: george@example.com + TeamAddMemberRequestAccountId: + summary: Account ID Example + value: + account_id: f57db65d3f933b5316d398057a36176831451a35 + TeamCreateRequest: + summary: Default Example + value: + name: New Team Name + TeamRemoveMemberRequest: + summary: Email Address Example + value: + email_address: teammate@dropboxsign.com + new_owner_email_address: new_teammate@dropboxsign.com + TeamRemoveMemberRequestAccountId: + summary: Account ID Example + value: + account_id: f57db65d3f933b5316d398057a36176831451a35 + TeamUpdateRequest: + summary: Default Example + value: + name: New Team Name + TemplateAddUserRequest: + summary: Default Example + value: + email_address: george@dropboxsign.com + TemplateCreateRequest: + summary: Default Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + placeholder: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 1 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + test_mode: true + TemplateCreateRequestFormFieldsPerDocument: + summary: Form Fields Per Document Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + placeholder: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 1 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + test_mode: true + TemplateCreateRequestFormFieldGroups: + summary: Form Fields Per Document and Groups Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: radio + x: 112 + 'y': 328 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 1 + signer: 0 + page: 1 + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: radio + x: 112 + 'y': 370 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 0 + signer: 0 + page: 1 + form_field_groups: + - group_id: RadioItemGroup1 + group_label: Radio Item Group 1 + requirement: require_0-1 + test_mode: true + TemplateCreateRequestFormFieldRules: + summary: Form Fields Per Document and Rules Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 0 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + form_field_rules: + - id: rule_1 + trigger_operator: AND + triggers: + - id: uniqueIdHere_1 + operator: is + value: foo + actions: + - field_id: uniqueIdHere_2 + hidden: 1 + type: change-field-visibility + test_mode: true + TemplateCreateEmbeddedDraftRequest: + summary: Default Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + test_mode: true + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: + summary: Form Fields Per Document Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + placeholder: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 1 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + test_mode: true + TemplateCreateEmbeddedDraftRequestFormFieldGroups: + summary: Form Fields Per Document and Groups Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: radio + x: 112 + 'y': 328 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 1 + signer: 0 + page: 1 + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: radio + x: 112 + 'y': 370 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 0 + signer: 0 + page: 1 + form_field_groups: + - group_id: RadioItemGroup1 + group_label: Radio Item Group 1 + requirement: require_0-1 + test_mode: true + TemplateCreateEmbeddedDraftRequestFormFieldRules: + summary: Form Fields Per Document and Rules Example + value: + client_id: 37dee8d8440c66d54cfa05d92c160882 + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + title: Test Template + subject: Please sign this document + message: For your approval + signer_roles: + - name: Client + order: 0 + - name: Witness + order: 1 + cc_roles: + - Manager + merge_fields: + - name: Full Name + type: text + - name: Is Registered? + type: checkbox + field_options: + date_format: DD - MM - YYYY + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 0 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + form_field_rules: + - id: rule_1 + trigger_operator: AND + triggers: + - id: uniqueIdHere_1 + operator: is + value: foo + actions: + - field_id: uniqueIdHere_2 + hidden: 1 + type: change-field-visibility + test_mode: true + TemplateRemoveUserRequest: + summary: Default Example + value: + email_address: george@dropboxsign.com + TemplateUpdateFilesRequest: + summary: Default Example + value: + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + UnclaimedDraftCreateRequest: + summary: Default Example + value: + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + signers: + - email_address: jack@example.com + name: Jack + order: 0 + type: request_signature + test_mode: true + UnclaimedDraftCreateRequestFormFieldsPerDocument: + summary: Form Fields Per Document Example + value: + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + placeholder: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 1 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + type: request_signature + test_mode: false + UnclaimedDraftCreateRequestFormFieldGroups: + summary: Form Fields Per Document and Groups Example + value: + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: radio + x: 112 + 'y': 328 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 1 + signer: 0 + page: 1 + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: radio + x: 112 + 'y': 370 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 0 + signer: 0 + page: 1 + form_field_groups: + - group_id: RadioItemGroup1 + group_label: Radio Item Group 1 + requirement: require_0-1 + type: request_signature + test_mode: false + UnclaimedDraftCreateRequestFormFieldRules: + summary: Form Fields Per Document and Rules Example + value: + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 0 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + form_field_rules: + - id: rule_1 + trigger_operator: AND + triggers: + - id: uniqueIdHere_1 + operator: is + value: foo + actions: + - field_id: uniqueIdHere_2 + hidden: 1 + type: change-field-visibility + type: request_signature + test_mode: false + UnclaimedDraftCreateEmbeddedRequest: + summary: Default Example + value: + client_id: b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + requester_email_address: jack@dropboxsign.com + test_mode: true + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: + summary: Form Fields Per Document Example + value: + client_id: b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + placeholder: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 1 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + requester_email_address: jack@dropboxsign.com + test_mode: false + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: + summary: Form Fields Per Document and Groups Example + value: + client_id: b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: radio + x: 112 + 'y': 328 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 1 + signer: 0 + page: 1 + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: radio + x: 112 + 'y': 370 + width: 18 + height: 18 + required: false + group: RadioItemGroup1 + is_checked: 0 + signer: 0 + page: 1 + form_field_groups: + - group_id: RadioItemGroup1 + group_label: Radio Item Group 1 + requirement: require_0-1 + requester_email_address: jack@dropboxsign.com + test_mode: false + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: + summary: Form Fields Per Document and Rules Example + value: + client_id: b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + file_urls: + - https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1 + form_fields_per_document: + - document_index: 0 + api_id: uniqueIdHere_1 + name: '' + type: text + x: 112 + 'y': 328 + width: 100 + height: 16 + required: true + signer: 0 + page: 1 + validation_type: numbers_only + - document_index: 0 + api_id: uniqueIdHere_2 + name: '' + type: signature + x: 530 + 'y': 415 + width: 120 + height: 30 + required: true + signer: 0 + page: 1 + form_field_rules: + - id: rule_1 + trigger_operator: AND + triggers: + - id: uniqueIdHere_1 + operator: is + value: foo + actions: + - field_id: uniqueIdHere_2 + hidden: 1 + type: change-field-visibility + requester_email_address: jack@dropboxsign.com + test_mode: false + UnclaimedDraftCreateEmbeddedWithTemplateRequest: + summary: Default Example + value: + client_id: b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + template_ids: + - 61a832ff0d8423f91d503e76bfbcc750f7417c78 + requester_email_address: jack@dropboxsign.com + signers: + - role: Client + name: George + email_address: george@example.com + ccs: + - role: Accounting + email_address: accounting@dropboxsign.com + test_mode: false + UnclaimedDraftEditAndResendRequest: + summary: Default Example + value: + client_id: b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + test_mode: false + AccountCreateResponse: + summary: Account Create + value: + account: + account_id: a2b31224f7e6fb5581d2f8cbd91cf65fa2f86aae + email_address: newuser@dropboxsign.com + is_paid_hs: false + is_paid_hf: false + is_locked: false + quotas: + templates_left: 0 + api_signature_requests_left: 0 + documents_left: 3 + sms_signatures_left: 5 + callback_url: null + role_code: null + locale: en-US + AccountCreateOAuthResponse: + summary: Account Create with OAuth Authorization + value: + account: + account_id: b4680b45053c7601ca1eee3b126eca6b2b0a0219 + email_address: jill@example.com + callback_url: null + role_code: null + oauth_data: + access_token: NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc= + token_type: Bearer + refresh_token: hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3 + expires_in: 86400 + AccountGetResponse: + summary: Account Get + value: + account: + account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + api_signature_requests_left: 1250 + documents_left: null + templates_left: null + sms_signatures_left: 1 + callback_url: null + role_code: null + locale: en-US + AccountVerifyFoundResponse: + summary: Account Found + value: + account: + email_address: some_user@dropboxsign.com + AccountVerifyNotFoundResponse: + summary: Account Not Found + value: {} + ApiAppGetResponse: + summary: API App + value: + api_app: + callback_url: null + client_id: 0dd3b823a682527788c4e40cb7b6f7e9 + created_at: 1436232339 + domains: + - example.com + is_approved: true + name: My Production App + oauth: + callback_url: https://example.com/oauth + scopes: + - basic_account_info + - request_signature + secret: 98891a1b59f312d04cd88e4e0c498d75 + owner_account: + account_id: dc5deeb9e10b044c591ef2475aafad1d1d3bd888 + email_address: john@example.com + ApiAppListResponse: + summary: API App List + value: + api_apps: + - callback_url: null + client_id: 0dd3b823a682527788c4e40cb7b6f7e9 + created_at: 1436232339 + domains: + - example.com + is_approved: true + name: My Production App + oauth: + callback_url: https://example.com/oauth + scopes: + - basic_account_info + - request_signature + secret: 98891a1b59f312d04cd88e4e0c498d75 + owner_account: + account_id: dc5deeb9e10b044c591ef2475aafad1d1d3bd888 + email_address: john@example.com + - callback_url: null + client_id: bff6d867fafcca27554cf89b1ca98793 + created_at: 1433458421 + domains: + - example.com + is_approved: false + name: My Other App + oauth: null + owner_account: + account_id: dc5deeb9e10b044c591ef2475aafad1d1d3bd888 + email_address: john@example.com + list_info: + num_pages: 1 + num_results: 2 + page: 1 + page_size: 20 + BulkSendJobGetResponse: + summary: Bulk Send Job + value: + bulk_send_job: + bulk_send_job_id: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174 + total: 1 + is_creator: true + created_at: 1532640962 + list_info: + page: 1 + num_pages: 1 + num_results: 1 + page_size: 20 + signature_requests: + - signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + subject: Purchase Agreement + message: Please sign and return. + is_complete: true + is_declined: false + has_error: false + custom_fields: [] + response_data: + - api_id: 80c678_1 + name: Needs Express Shipping + signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + value: true + type: checkbox + - api_id: 80c678_2 + name: Shipping Address + signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + value: 1212 Park Avenue + type: text + - api_id: 80c678_3 + name: DateSigned + signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + value: 09/01/2012 + type: text + signing_url: null + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + cc_email_addresses: [] + bulk_send_job_id: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174 + BulkSendJobListResponse: + summary: Bulk Send Job List + value: + list_info: + page: 1 + num_pages: 1 + num_results: 2 + page_size: 20 + bulk_send_jobs: + - bulk_send_job_id: fef03f144d9384737a98ff2ca6c1fd9d7bc2239a + total: 250 + is_creator: false + created_at: 1532740871 + - bulk_send_job_id: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174 + total: 1 + is_creator: true + created_at: 1532640962 + EmbeddedEditUrlResponse: + summary: Embedded Edit URL + value: + embedded: + edit_url: https://app.hellosign.com/editor/embeddedTemplate?token=70ca8e5779c9a931125db09f3170efc1&root_snapshot_guids[]=a97ce534aec6cbe09e70cdd55112e31bd320ed00&edited_template_guid=61a832ff0d8423f91d503e76bfbcc750f7417c78&guid=56ecaf0659aa29215d2ee489c0c88ff8c9496099&force_signer_input=1 + expires_at: 1634313821 + EmbeddedSignUrlResponse: + summary: Embedded Sign URL + value: + embedded: + sign_url: https://app.hellosign.com/editor/embeddedSign?signature_id=50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b&token=b6b8e7deaf8f0b95c029dca049356d4a2cf9710a + expires_at: 1634313821 + Error400Response: + summary: Error 400 bad_request + value: + error: + error_msg: This value should not be blank + error_path: cc_email_addresses[0] + error_name: bad_request + Error401Response: + summary: Error 401 unauthorized + value: + error: + error_msg: Unauthorized user. No credentials supplied. + error_name: unauthorized + Error402Response: + summary: Error 402 payment_required + value: + error: + error_msg: You must upgrade to make additional requests. + error_name: payment_required + Error403Response: + summary: Error 403 forbidden + value: + error: + error_msg: A paid API plan is required to access this endpoint. + error_name: forbidden + Error404Response: + summary: Error 404 not_found + value: + error: + error_msg: Not found. + error_name: not_found + Error409Response: + summary: Error 409 conflict + value: + error: + error_msg: An identical request is already being processed. + error_name: conflict + Error410Response: + summary: Error 410 deleted + value: + error: + error_msg: This resource has been deleted. + error_name: deleted + Error422Response: + summary: Error 422 unprocessable_entity + value: + error: + error_msg: This entity is unprocessable. + error_name: unprocessable_entity + Error429Response: + summary: Error 429 exceeded_rate + value: + error: + error_msg: Too many requests. + error_name: exceeded_rate + Error4XXResponse: + summary: Error 4XX failed_operation + value: + error: + error_msg: This value should not be blank + error_path: cc_email_addresses[0] + error_name: bad_request + FaxGetResponse: + summary: Fax Response + value: + fax: + fax_id: c2e9691c85d9d6fa6ae773842e3680b2b8650f1d + title: example title + original_title: example original title + subject: example subject + message: example message + metadata: [] + created_at: 1726774555 + sender: me@dropboxsign.com + transmissions: + - recipient: recipient@dropboxsign.com + sender: me@dropboxsign.com + sent_at: 1723231831 + status_code: success + files_url: https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2 + FaxLineResponse: + summary: Sample Fax Line Response + value: + fax_line: + number: '[FAX_NUMBER]' + created_at: 1723231831 + updated_at: 1723231831 + accounts: + - account_id: c2e9691c85d9d6fa6ae773842e3680b2b8650f1d + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: false + is_paid_hf: true + FaxLineAreaCodeGetResponse: + summary: Sample Area Code Response + value: + area_codes: + - 209 + - 213 + - 310 + - 323 + - 408 + - 415 + - 424 + - 510 + - 530 + - 559 + - 562 + - 619 + - 626 + - 650 + - 657 + - 661 + - 669 + - 707 + - 714 + - 747 + - 760 + - 805 + - 818 + - 831 + - 858 + - 909 + - 916 + - 925 + - 949 + - 951 + FaxLineListResponse: + summary: Sample Fax Line List Response + value: + list_info: + num_pages: 1 + num_results: 1 + page: 1 + page_size: 1 + fax_lines: + - number: '[FAX_NUMBER]' + created_at: 1723231831 + updated_at: 1723231831 + accounts: + - account_id: c2e9691c85d9d6fa6ae773842e3680b2b8650f1d + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: false + is_paid_hf: true + FaxListResponse: + summary: Returns the properties and settings of multiple Faxes + value: + list_info: + num_pages: 1 + num_results: 1 + page: 1 + page_size: 1 + faxes: + - fax_id: c2e9691c85d9d6fa6ae773842e3680b2b8650f1d + title: example title + original_title: example original title + subject: example subject + message: example message + metadata: [] + created_at: 1726774555 + sender: me@dropboxsign.com + transmissions: + - recipient: recipient@dropboxsign.com + sender: me@dropboxsign.com + sent_at: 1723231831 + status_code: success + files_url: https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2 + ReportCreateResponse: + summary: Report + value: + report: + success: Your request is being processed. You will receive an email when the report is ready. + start_date: 09/01/2020 + end_date: 09/02/2020 + report_type: + - user_activity + - document_status + SignatureRequestGetResponse: + summary: Get Signature Request + value: + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: true + is_declined: false + has_error: false + custom_fields: [] + response_data: + - api_id: 80c678_1 + name: Needs Express Shipping + signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + value: true + type: checkbox + - api_id: 80c678_2 + name: Shipping Address + signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + value: 1212 Park Avenue + type: text + - api_id: 80c678_3 + name: DateSigned + signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + value: 09/01/2012 + type: text + signing_url: null + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + SignatureRequestListResponse: + summary: List Signature Requests + value: + list_info: + page: 1 + num_pages: 1 + num_results: 2 + page_size: 20 + signature_requests: + - signature_request_id: d10338cad145e1cb68afc828 + title: FHA + original_title: FHA + subject: FHA + message: Let me know if you two have any questions. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: https://app.hellosign.com/sign/d10338cad145e1cb68afc828 + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=d10338cad145e1cb68afc828 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: george-jetson@example.com + signer_name: George Jetson + 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: jane-jetson@example.com + signer_name: Jane Jetson + 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: + - stan@example.com + - signature_request_id: fa5c8a0b0f492d768749333a + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement + message: Please sign and return. + metadata: {} + is_complete: true + is_declined: false + has_error: false + custom_fields: [] + response_data: + - api_id: uniqueIdHere_1 + name: Needs Express Shipping + signature_id: 5687fb7bd5aaacb1689728762b600c74 + value: true + type: checkbox + - api_id: uniqueIdHere_2 + name: Shipping Address + signature_id: 5687fb7bd5aaacb1689728762b600c74 + value: 1212 Park Avenue + type: text + - api_id: uniqueIdHere_3 + name: DateSigned + signature_id: 5687fb7bd5aaacb1689728762b600c74 + value: 09/01/2012 + type: date_signed + signing_url: null + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333a + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 5687fb7bd5aaacb1689728762b600c74 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + cc_email_addresses: [] + AccountUpdateResponse: + summary: Account Update + value: + account: + account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + api_signature_requests_left: 1250 + documents_left: null + templates_left: null + sms_signatures_left: 1 + callback_url: https://www.example.com/callback + role_code: null + locale: en-US + OAuthTokenGenerateResponse: + summary: Retrieving the OAuth token + value: + access_token: NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc= + token_type: Bearer + refresh_token: hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3 + expires_in: 86400 + state: 900e06e2 + OAuthTokenRefreshResponse: + summary: Refresh an existing OAuth token + value: + access_token: MDZhYzBlMGI1YzQ0ZjI1ZjYzYmUyNmMzZWQ5ZGNmOGYyNmQxMmMyMmQ2NmNiY2M3NW= + expires_in: 86400 + refresh_token: hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3 + token_type: Bearer + ApiAppCreateResponse: + summary: API App + value: + api_app: + callback_url: null + client_id: 0dd3b823a682527788c4e40cb7b6f7e9 + created_at: 1436232339 + domains: + - example.com + is_approved: false + name: My Production App + oauth: + callback_url: https://example.com/oauth + scopes: + - basic_account_info + - request_signature + secret: 98891a1b59f312d04cd88e4e0c498d75 + owner_account: + account_id: dc5deeb9e10b044c591ef2475aafad1d1d3bd888 + email_address: john@example.com + white_labeling_options: + primary_button_color: '#00b3e6' + primary_button_text_color: '#ffffff' + ApiAppUpdateResponse: + summary: API App Update + value: + api_app: + callback_url: https://example.com/dropboxsign + client_id: 0dd3b823a682527788c4e40cb7b6f7e9 + created_at: 1436232339 + domains: + - example.com + is_approved: false + name: New Name + oauth: + callback_url: https://example.com/oauth + scopes: + - basic_account_info + - request_signature + secret: 98891a1b59f312d04cd88e4e0c498d75 + owner_account: + account_id: dc5deeb9e10b044c591ef2475aafad1d1d3bd888 + email_address: john@example.com + white_labeling_options: + primary_button_color: '#00b3e6' + primary_button_text_color: '#ffffff' + SignatureRequestCreateEmbeddedResponse: + summary: Create Embedded Signature Request + value: + 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 + SignatureRequestCreateEmbeddedWithTemplateResponse: + summary: Create Embedded Signature Request With Template + value: + 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 + SignatureRequestFilesResponse: + summary: Signature Requests Files + value: + file_url: https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=EXAMPLE_ACCESS_KEY_ID&Expires=1452868903&Signature=EXAMPLE_SIGNATURE + expires_at: 1458605123 + SignatureRequestReleaseHoldResponse: + summary: Send Signature Release Hold + value: + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: ok + subject: ok + message: null + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: https://app.hellosign.com/sign/fa5c8a0b0f492d768749333ad6fcc214c111e967 + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 5687fb7bd5aaacb1689728762b600c74 + signer_email_address: john@example.com + signer_name: John Doe + order: 0 + status_code: awaiting_signature + signed_at: null + last_viewed_at: null + last_reminded_at: 1346616433 + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + SignatureRequestRemindResponse: + summary: Send Signature Request Reminder + value: + signature_request: + signature_request_id: 2f9781e1a8e2045224d808c153c2e1d3df6f8f2f + title: ok + original_title: ok + subject: ok + metadata: {} + message: null + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: https://app.hellosign.com/sign/2f9781e1a8e2045224d808c153c2e1d3df6f8f2f + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=2f9781e1a8e2045224d808c153c2e1d3df6f8f2f + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 5687fb7bd5aaacb1689728762b600c74 + signer_email_address: john@example.com + signer_name: John Doe + order: 0 + status_code: awaiting_signature + signed_at: null + last_viewed_at: null + last_reminded_at: 1346616433 + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + SignatureRequestSendResponse: + summary: Send Signature Request + value: + 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 + SignatureRequestSendWithTemplateResponse: + summary: Send Signature Request With Template + value: + 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 + SignatureRequestUpdateResponse: + summary: Signature Request Update + value: + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + subject: Purchase Agreement + message: Please sign and return. + created_at: 1570471067 + is_complete: true + has_error: false + custom_fields: [] + signing_url: null + signing_redirect_url: null + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: danaerys@mereen.gov.ws + signer_name: Danaerys Stormborn + signer_role: null + 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: [] + SignatureRequestBulkSendWithTemplateResponse: + summary: Send Signature Request With Template + value: + bulk_send_job: + bulk_send_job_id: 4bce667844dc3711d05e7aa4a1b5a6b64b738b2b + total: 1 + is_creator: true + created_at: 1532640962 + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: + summary: Bulk Send Create Embedded Signature Request With Template + value: + bulk_send_job: + bulk_send_job_id: ccaf88244ef006b6e31ebba5ed4cb53b3131d9ac + total: 3 + is_creator: true + created_at: 1543556038 + TeamCreateResponse: + summary: Team Create + value: + team: + name: New Team Name + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: null + api_signature_requests_left: 1250 + role_code: a + invited_accounts: [] + invited_emails: [] + TeamMembersResponse: + summary: Team Members List + value: + list_info: + page: 1 + num_pages: 1 + num_results: 2 + page_size: 20 + members: + - account_id: bb7e16df3cf8944a059ae908ba914539c1ce3d13 + email_address: team-admin@example.com + role: Admin + - account_id: 29b09ebad6013a2b56cda80ccdc25847158e06a8 + email_address: developer@example.com + role: Developer + TeamRemoveMemberResponse: + summary: Team Remove Member + value: + team: + name: Team Dropbox Sign + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: null + api_signature_requests_left: 1250 + role_code: a + invited_accounts: + - account_id: 8e239b5a50eac117fdd9a0e2359620aa57cb2463 + email_address: george@hellofax.com + is_locked: false + is_paid_hs: false + is_paid_hf: false + quotas: + templates_left: 0 + documents_left: 3 + api_signature_requests_left: 0 + invited_emails: + - invite_1@example.com + - invite_2@example.com + - invite_3@example.com + TeamUpdateResponse: + summary: Team Update + value: + team: + name: New Team Name + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: null + api_signature_requests_left: 1250 + role_code: a + invited_accounts: + - account_id: 8e239b5a50eac117fdd9a0e2359620aa57cb2463 + email_address: george@hellofax.com + is_locked: false + is_paid_hs: false + is_paid_hf: false + quotas: + templates_left: 0 + documents_left: 3 + api_signature_requests_left: 0 + invited_emails: + - invite_1@example.com + - invite_2@example.com + - invite_3@example.com + TeamDoesNotExistResponse: + summary: Team Does Not Exist + value: + error: + error_msg: Team does not exist + error_name: not_found + TemplateAddUserResponse: + summary: Add User to Template + value: + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_creator: true + is_embedded: false + can_edit: true + metadata: {} + is_locked: false + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + signer: '1' + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + signer: '2' + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + signer: '1' + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + signer: '2' + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_3 + name: ManagerName + type: text + signer: '2' + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + signer: '2' + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + signer: '1' + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + signer: null + x: 378 + 'y': 36 + width: 84 + height: 14 + required: false + api_id: 78083014-32d8-4b5b-b65e-fe6010f3be64 + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 22 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + - account_id: '' + email_address: teammate@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + TemplateFilesResponse: + summary: Template Files + value: + file_url: https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=EXAMPLE_ACCESS_KEY_ID&Expires=1452868903&Signature=EXAMPLE_SIGNATURE + expires_at: 1458605123 + TemplateRemoveUserResponse: + summary: Remove User from Template + value: + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_creator: true + is_embedded: false + can_edit: true + metadata: {} + is_locked: false + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + signer: '1' + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + signer: '2' + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + signer: '1' + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + signer: '2' + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_3 + name: ManagerName + type: text + signer: '2' + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + signer: '2' + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + signer: '1' + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + signer: null + x: 378 + 'y': 36 + width: 84 + height: 14 + required: false + api_id: 78083014-32d8-4b5b-b65e-fe6010f3be64 + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 22 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + UnclaimedDraftCreateEmbeddedResponse: + summary: Unclaimed Draft Create Embedded + value: + unclaimed_draft: + claim_url: https://embedded.hellosign.com/prep-and-send/embedded-request?cached_params_token=30c4d8df776038c2fa5f7094c3718937 + signing_redirect_url: null + expires_at: 1414093891 + test_mode: true + signature_request_id: 340e9843ac552b5170ee9c374d67e312f53ca129 + requesting_redirect_url: null + UnclaimedDraftCreateEmbeddedWithTemplateResponse: + summary: Unclaimed Draft Create Embedded With Template + value: + unclaimed_draft: + claim_url: https://embedded.hellosign.com/prep-and-send/embedded-request?cached_params_token=30c4d8df776038c2fa5f7094c3718937 + signature_request_id: 8e55b3880c62497791dda0f3b4181cfd95f7ddb4 + signing_redirect_url: null + requesting_redirect_url: null + test_mode: true + UnclaimedDraftEditAndResend: + summary: Unclaimed Draft Edit and Resend + value: + unclaimed_draft: + claim_url: https://embedded.hellosign.com/prep-and-send/embedded-request?cached_params_token=30c4d8df776038c2fa5f7094c3718937 + signature_request_id: 8e55b3880c62497791dda0f3b4181cfd95f7ddb4 + signing_redirect_url: null + requesting_redirect_url: null + test_mode: true + expires_at: 1414093891 + TeamGetResponse: + summary: Team Get + value: + team: + name: Team Dropbox Sign + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: null + api_signature_requests_left: 1250 + role_code: a + - account_id: d3d3d7b98d80b67d07740df7cdfd1f49fa8e2b82 + email_address: teammate@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: null + api_signature_requests_left: 1250 + role_code: m + invited_accounts: + - account_id: 8e239b5a50eac117fdd9a0e2359620aa57cb2463 + email_address: george@hellofax.com + is_locked: false + is_paid_hs: false + is_paid_hf: false + quotas: + templates_left: 0 + documents_left: 3 + api_signature_requests_left: 0 + invited_emails: + - invite_1@example.com + - invite_2@example.com + - invite_3@example.com + TeamGetInfoResponse: + summary: Team Get Info + value: + team: + team_id: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + name: Team A + num_sub_teams: 4 + num_members: 0 + parent_team: + team_id: 89dc8eea8361bf7dc760b09004856a9d4eae8faa + name: Root Team + TeamInvitesResponse: + summary: Team Invites + value: + team_invites: + - email_address: user@dropboxsign.com + team_id: e51f544655faa0f79e2a811c94eacaadf854162c + role: Member + sent_at: 1663261509 + redeemed_at: null + expires_at: 1663263958 + TeamAddMemberResponse: + summary: Team Add Member + value: + team: + name: New Team Name + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: null + api_signature_requests_left: 1250 + role_code: a + invited_accounts: + - account_id: 8e239b5a50eac117fdd9a0e2359620aa57cb2463 + email_address: george@hellofax.com + is_locked: false + is_paid_hs: false + is_paid_hf: false + quotas: + templates_left: 0 + documents_left: 3 + api_signature_requests_left: 0 + invited_emails: + - invite_1@example.com + - invite_2@example.com + - invite_3@example.com + TeamSubTeamsResponse: + summary: Team Sub Teams List + value: + list_info: + page: 1 + num_pages: 1 + num_results: 4 + page_size: 20 + sub_teams: + - team_id: 29b09ebad6013a2b56cda80ccdc25847158e06a8 + name: Team A + - team_id: d6218f881ec36ae628507fa60c8099934730b7ca + name: Team B + TemplateCreateResponse: + summary: Create Template + value: + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_creator: true + is_embedded: false + can_edit: true + metadata: {} + is_locked: false + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + signer: '1' + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + signer: '2' + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + signer: '1' + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + signer: '2' + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_3 + name: ManagerName + type: text + signer: '2' + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + signer: '2' + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + signer: '1' + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + signer: null + x: 378 + 'y': 36 + width: 84 + height: 14 + required: false + api_id: 78083014-32d8-4b5b-b65e-fe6010f3be64 + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 22 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + TemplateCreateEmbeddedDraftResponse: + summary: Create Embedded Draft Template + value: + template: + template_id: 61a832ff0d8423f91d503e76bfbcc750f7417c78 + edit_url: https://app.hellosign.com/editor/embeddedTemplate?token=8d80ead273a0405d6844005a20beb99b&root_snapshot_guids%5B0%5D=74cc144a76afa5bdca3378278e9a6ac3c2947c92&snapshot_access_guids%5B0%5D=9ceac764&guid=61a832ff0d8423f91d503e76bfbcc750f7417c78 + expires_at: 1427306768 + TemplateGetResponse: + summary: Get Template + value: + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_creator: true + is_embedded: false + can_edit: true + metadata: {} + is_locked: false + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + signer: '1' + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + signer: '2' + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + signer: '1' + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + signer: '2' + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_3 + name: ManagerName + type: text + signer: '2' + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + signer: '2' + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + signer: '1' + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + signer: null + x: 378 + 'y': 36 + width: 84 + height: 14 + required: false + api_id: 78083014-32d8-4b5b-b65e-fe6010f3be64 + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 22 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + TemplateListResponse: + summary: List Templates + value: + list_info: + page: 1 + num_pages: 1 + num_results: 2 + page_size: 20 + templates: + - template_id: c26b8a16784a872da37ea946b9ddec7c1e11dff6 + title: Purchase order + message: '' + updated_at: 1570471067 + is_creator: false + is_embedded: false + can_edit: true + metadata: {} + is_locked: false + signer_roles: + - name: Client + cc_roles: + - name: Accounting + documents: + - index: 0 + name: purchase_order.pdf + field_groups: [] + form_fields: [] + custom_fields: + - name: Cost + type: text + signer: null + x: 378 + 'y': 36 + width: 84 + height: 14 + required: false + api_id: b0e195cf-fb85-4dd4-94ab-6f62450c7059 + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 22 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + - template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_creator: true + is_embedded: false + can_edit: true + metadata: {} + is_locked: false + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + signer: '1' + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + signer: '2' + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + signer: '1' + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + signer: '2' + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_3 + name: ManagerName + type: text + signer: '2' + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + signer: '2' + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 19 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + signer: '1' + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + signer: null + x: 378 + 'y': 36 + width: 84 + height: 14 + required: false + api_id: 78083014-32d8-4b5b-b65e-fe6010f3be64 + group: null + avg_text_length: + num_lines: 1 + num_chars_per_line: 22 + isMultiline: false + originalFontSize: 12 + fontFamily: arial + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + templates_left: null + documents_left: 3600000 + api_signature_requests_left: 0 + sms_verifications_left: 300000 + TemplateUpdateFilesResponse: + summary: Update Template Files + value: + template: + template_id: f57db65d3f933122019888057a36176831451a35 + UnclaimedDraftCreateResponse: + summary: Unclaimed Draft Create + value: + unclaimed_draft: + claim_url: https://app.hellosign.com/send/resendDocs?root_snapshot_guids[]=7f967b7d06e154394eab693febedf61e8ebe49eb&snapshot_access_guids[]=fb848631&root_snapshot_guids[]=7aedaf31e12edf9f2672a0b2ddf028aca670e101&snapshot_access_guids[]=f398ef87 + signing_redirect_url: null + expires_at: 1414093891 + test_mode: true + EventCallbackAccountSignatureRequestSent: + summary: 'Example: signature_request_sent' + value: + event: + event_time: '1348177752' + event_type: signature_request_sent + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackAccountTemplateCreated: + summary: 'Example: template_created' + value: + event: + event_time: '1348177752' + event_type: template_created + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_embedded: false + metadata: {} + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_3 + name: ManagerName + type: text + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + x-fern-audiences: + - events + EventCallbackAppAccountConfirmed: + summary: 'Example: account_confirmed' + value: + event: + event_time: '1348177752' + event_type: account_confirmed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: null + reported_for_app_id: 5b6eac0ac5f82db0cf5f394ce4f6b150 + account: + account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + api_signature_requests_left: 1250 + documents_left: null + templates_left: null + callback_url: null + role_code: null + x-fern-audiences: + - events + EventCallbackAppSignatureRequestSent: + summary: 'Example: signature_request_sent' + value: + event: + event_time: '1348177752' + event_type: signature_request_sent + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: null + reported_for_app_id: 5b6eac0ac5f82db0cf5f394ce4f6b150 + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: 5b6eac0ac5f82db0cf5f394ce4f6b150 + x-fern-audiences: + - events + EventCallbackAppTemplateCreated: + summary: 'Example: template_created' + value: + event: + event_time: '1348177752' + event_type: template_created + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: null + reported_for_app_id: 5b6eac0ac5f82db0cf5f394ce4f6b150 + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_embedded: false + metadata: {} + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_3 + name: ManagerName + type: text + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + x-fern-audiences: + - events + EventCallbackSignatureRequestViewed: + summary: Signature Request Viewed Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_viewed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestSigned: + summary: Signature Request Signed Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_signed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestSignerRemoved: + summary: Signature Request Signer Removed Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_signer_removed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestDownloadable: + summary: Signature Request Downloadable Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_downloadable + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: true + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestSent: + summary: Signature Request Sent Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_sent + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestAllSigned: + summary: Signature Request All Signed Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_all_signed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: true + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestInvalid: + summary: Signature Request Invalid Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_invalid + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: true + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestEmailBounce: + summary: Signature Request Email Bounce Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_email_bounce + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestRemind: + summary: Signature Request Remind Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_remind + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestIncompleteQes: + summary: Signature Request Incomplete QES Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_incomplete_qes + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestDestroyed: + summary: Signature Request Destroyed Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_destroyed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestCanceled: + summary: Signature Request Canceled Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_canceled + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestDeclined: + summary: Signature Request Declined Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_declined + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: true + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestExpired: + summary: Signature Request Expired Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_expired + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestReassigned: + summary: Signature Request Reassigned Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_reassigned + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackSignatureRequestPrepared: + summary: Signature Request Prepared Event Example + value: + event: + event_time: '1348177752' + event_type: signature_request_prepared + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: false + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackAccountConfirmed: + summary: Account Confirmed Event Example + value: + event: + event_time: '1348177752' + event_type: account_confirmed + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + account: + account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + is_locked: false + is_paid_hs: true + is_paid_hf: false + quotas: + api_signature_requests_left: 1250 + documents_left: null + templates_left: null + callback_url: null + role_code: null + x-fern-audiences: + - events + EventCallbackUnknownError: + summary: Unknown Error Event Example + value: + event: + event_time: '1348177752' + event_type: unknown_error + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: true + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackFileError: + summary: File Error Event Example + value: + event: + event_time: '1348177752' + event_type: file_error + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: true + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackTemplateCreated: + summary: Template Created Event Example + value: + event: + event_time: '1348177752' + event_type: template_created + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_embedded: false + metadata: {} + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_3 + name: ManagerName + type: text + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + x-fern-audiences: + - events + EventCallbackTemplateError: + summary: Template Error Event Example + value: + event: + event_time: '1348177752' + event_type: template_error + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + template: + template_id: f57db65d3f933b5316d398057a36176831451a35 + title: Mutual NDA + message: Please sign this NDA as soon as possible. + updated_at: 1570471067 + is_embedded: false + metadata: {} + signer_roles: + - name: Outside Vendor + order: 0 + - name: Internal Manager + order: 1 + cc_roles: + - name: Corporate Attorney + documents: + - index: 0 + name: mutual_nda.pdf + field_groups: + - name: group1 + rule: require_1-ormore + form_fields: + - api_id: b65e03_10 + name: DepartmentA + type: checkbox + x: 117 + 'y': 19 + width: 15 + height: 15 + required: false + group: group1 + - api_id: b65e03_11 + name: DepartmentB + type: checkbox + x: 118 + 'y': 41 + width: 15 + height: 15 + required: false + group: group1 + - api_id: 0ec7a7_1 + name: VendorName + type: text + x: 160 + 'y': 141 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_2 + name: VendorTitle + type: text + x: 160 + 'y': 181 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_3 + name: ManagerName + type: text + x: 160 + 'y': 221 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_4 + name: ManagerTitle + type: text + x: 160 + 'y': 251 + width: 80 + height: 30 + required: true + group: null + - api_id: 0ec7a7_5 + name: DateSigned + type: date_signed + x: 523 + 'y': 28 + width: 105 + height: 16 + required: true + group: null + custom_fields: + - name: Effective Date + type: text + accounts: + - account_id: 5008b25c7f67153e57d5a357b1687968068fb465 + email_address: me@dropboxsign.com + x-fern-audiences: + - events + EventCallbackSignUrlInvalid: + summary: Sign URL Invalid Event Example + value: + event: + event_time: '1348177752' + event_type: sign_url_invalid + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: ad4d8a769b555fa5ef38691465d426682bf2c992 + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + signature_request: + signature_request_id: fa5c8a0b0f492d768749333ad6fcc214c111e967 + title: Purchase Agreement + original_title: Purchase Agreement + subject: Purchase Agreement we talked about + message: Please sign and return. + metadata: {} + created_at: 1570471067 + is_complete: false + is_declined: false + has_error: true + custom_fields: [] + response_data: [] + signing_url: null + signing_redirect_url: null + files_url: https://api.hellosign.com/v3/signature_request/files/2d055d5449fcbf016f5ebf0cf967bdd2bc42494f + details_url: https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967 + requester_email_address: me@dropboxsign.com + signatures: + - signature_id: 78caf2a1d01cd39cea2bc1cbb340dac3 + signer_email_address: john@example.com + signer_name: John Doe + signer_role: null + order: null + status_code: signed + signed_at: 1346521550 + last_viewed_at: 1346521483 + last_reminded_at: null + has_pin: false + has_sms_auth: false + cc_email_addresses: [] + template_ids: null + client_id: null + x-fern-audiences: + - events + EventCallbackCallbackTest: + summary: Callback Test Event Example + value: + event: + event_time: '1348177752' + event_type: callback_test + event_hash: 3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947 + event_metadata: + related_signature_id: null + reported_for_account_id: null + reported_for_app_id: null + x-fern-audiences: + - events + requestBodies: + EventCallbackAccountRequest: + description: |- + **Account Callback Payloads --** + Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`. + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/EventCallbackRequest' + examples: + signature_request_sent_example: + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' + template_created_example: + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' + EventCallbackAppRequest: + description: |- + **API App Callback Payloads --** + Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`. + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/EventCallbackRequest' + examples: + account_confirmed_example: + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' + signature_request_sent_example: + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' + template_created_example: + $ref: '#/components/examples/EventCallbackAppTemplateCreated' + headers: + X-RateLimit-Limit: + description: The maximum number of requests per hour that you can make. + schema: + type: integer + format: int32 + example: 100 + X-RateLimit-Remaining: + description: The number of requests remaining in the current rate limit window. + schema: + type: integer + format: int32 + example: 99 + X-Ratelimit-Reset: + description: The Unix time at which the rate limit will reset to its maximum. + schema: + type: integer + format: int64 + example: 1430170900 + securitySchemes: + api_key: + type: http + description: |- + Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information. + ✅ Supported by Try it console (calls sent in `test_mode` only). + scheme: basic + oauth2: + type: http + description: |- + You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. + ❌ **Not supported** by Try it console. + bearerFormat: JWT + scheme: bearer +webhooks: + accountUpdateEventCallback: + post: + summary: Account Callbacks + operationId: accountUpdateEventCallback + description: |- + This type of callback URL can be set up at the account level (either by setting it through an API request to "/v3/account" or on the Account Settings page on hellosign.com). + + All signature request events that involve your account are reported to this URL. This includes events such as receiving a signature request, or when a signature request you've sent is signed by someone. Events are reported to the account callback URL for either requests originating on hellosign.com, or on a partner site, via an embedded flow. + + You can set your account callback by using the [account API call](https://app.hellosign.com/api/account/post) or manually on the [settings page](https://app.hellosign.com/home/myAccount#api). + tags: + - Callbacks and Events + x-meta: + seo: + title: Account Callbacks | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.' + x-fern-audiences: + - events + requestBody: + description: |- + **Account Callback Payloads --** + Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`. + + > **Delivery format:** This payload is delivered to your callback URL as an HTTP `POST` with `Content-Type: multipart/form-data`. The JSON structure documented below is sent as the value of a single form field named `json`. The schema below describes that JSON value. + content: + application/json: + schema: + $ref: '#/components/schemas/EventCallbackPayload' + examples: + signature_request_viewed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestViewed' + signature_request_signed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestSigned' + signature_request_signer_removed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestSignerRemoved' + signature_request_downloadable_example: + $ref: '#/components/examples/EventCallbackSignatureRequestDownloadable' + signature_request_sent_example: + $ref: '#/components/examples/EventCallbackSignatureRequestSent' + signature_request_all_signed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestAllSigned' + signature_request_invalid_example: + $ref: '#/components/examples/EventCallbackSignatureRequestInvalid' + signature_request_email_bounce_example: + $ref: '#/components/examples/EventCallbackSignatureRequestEmailBounce' + signature_request_remind_example: + $ref: '#/components/examples/EventCallbackSignatureRequestRemind' + signature_request_incomplete_qes_example: + $ref: '#/components/examples/EventCallbackSignatureRequestIncompleteQes' + signature_request_destroyed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestDestroyed' + signature_request_canceled_example: + $ref: '#/components/examples/EventCallbackSignatureRequestCanceled' + signature_request_declined_example: + $ref: '#/components/examples/EventCallbackSignatureRequestDeclined' + signature_request_expired_example: + $ref: '#/components/examples/EventCallbackSignatureRequestExpired' + signature_request_reassigned_example: + $ref: '#/components/examples/EventCallbackSignatureRequestReassigned' + signature_request_prepared_example: + $ref: '#/components/examples/EventCallbackSignatureRequestPrepared' + account_confirmed_example: + $ref: '#/components/examples/EventCallbackAccountConfirmed' + unknown_error_example: + $ref: '#/components/examples/EventCallbackUnknownError' + file_error_example: + $ref: '#/components/examples/EventCallbackFileError' + template_created_example: + $ref: '#/components/examples/EventCallbackTemplateCreated' + template_error_example: + $ref: '#/components/examples/EventCallbackTemplateError' + sign_url_invalid_example: + $ref: '#/components/examples/EventCallbackSignUrlInvalid' + callback_test_example: + $ref: '#/components/examples/EventCallbackCallbackTest' + responses: + '200': + $ref: '#/components/responses/EventCallbackResponse' + apiAppCreateEventCallback: + post: + summary: App Callbacks + operationId: apiAppCreateEventCallback + description: |- + This type of callback URL is set up at the API app level. API apps are used to identify a partner integration and configure embedded flows ([embedded signign](https://app.hellosign.com/api/embeddedSigningWalkthrough), [embedded requesting](https://app.hellosign.com/api/embeddedRequestingWalkthrough), and [embedded templates](https://app.hellosign.com/api/embeddedTemplatesWalkthrough)) and [OAuth providers](https://app.hellosign.com/api/oauthWalkthrough) + + All events that involve signature requests created by an API app are reported to this URL. The event will include a `client_id` field to indicate which app the event is being reported for, which allows multiple API apps to share the same callback URL. + + You can manage your apps and their callbacks from the [settings page](https://app.hellosign.com/home/myAccount#api). + tags: + - Callbacks and Events + x-meta: + seo: + title: App Callbacks | API Documentation | Dropbox Sign for Developers + description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.' + x-fern-audiences: + - events + requestBody: + description: |- + **API App Callback Payloads --** + Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`. + + > **Delivery format:** This payload is delivered to your callback URL as an HTTP `POST` with `Content-Type: multipart/form-data`. The JSON structure documented below is sent as the value of a single form field named `json`. The schema below describes that JSON value. + content: + application/json: + schema: + $ref: '#/components/schemas/EventCallbackPayload' + examples: + signature_request_viewed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestViewed' + signature_request_signed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestSigned' + signature_request_signer_removed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestSignerRemoved' + signature_request_downloadable_example: + $ref: '#/components/examples/EventCallbackSignatureRequestDownloadable' + signature_request_sent_example: + $ref: '#/components/examples/EventCallbackSignatureRequestSent' + signature_request_all_signed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestAllSigned' + signature_request_invalid_example: + $ref: '#/components/examples/EventCallbackSignatureRequestInvalid' + signature_request_email_bounce_example: + $ref: '#/components/examples/EventCallbackSignatureRequestEmailBounce' + signature_request_remind_example: + $ref: '#/components/examples/EventCallbackSignatureRequestRemind' + signature_request_incomplete_qes_example: + $ref: '#/components/examples/EventCallbackSignatureRequestIncompleteQes' + signature_request_destroyed_example: + $ref: '#/components/examples/EventCallbackSignatureRequestDestroyed' + signature_request_canceled_example: + $ref: '#/components/examples/EventCallbackSignatureRequestCanceled' + signature_request_declined_example: + $ref: '#/components/examples/EventCallbackSignatureRequestDeclined' + signature_request_expired_example: + $ref: '#/components/examples/EventCallbackSignatureRequestExpired' + signature_request_reassigned_example: + $ref: '#/components/examples/EventCallbackSignatureRequestReassigned' + signature_request_prepared_example: + $ref: '#/components/examples/EventCallbackSignatureRequestPrepared' + account_confirmed_example: + $ref: '#/components/examples/EventCallbackAccountConfirmed' + unknown_error_example: + $ref: '#/components/examples/EventCallbackUnknownError' + file_error_example: + $ref: '#/components/examples/EventCallbackFileError' + template_created_example: + $ref: '#/components/examples/EventCallbackTemplateCreated' + template_error_example: + $ref: '#/components/examples/EventCallbackTemplateError' + sign_url_invalid_example: + $ref: '#/components/examples/EventCallbackSignUrlInvalid' + callback_test_example: + $ref: '#/components/examples/EventCallbackCallbackTest' + responses: + '200': + $ref: '#/components/responses/EventCallbackResponse' +x-error-codes: + bad_request: + http_status: 400 + summary: The request contained invalid or malformed parameters. + cause: 'A parameter failed validation, or the request body was malformed.' + remediation: 'Inspect error_msg and error_path, correct the offending parameter, and resend.' + retryable: 'no' + unauthorized: + http_status: 401 + summary: The credentials supplied are missing or invalid. + cause: 'Missing, malformed, or invalid API key or OAuth access token.' + remediation: 'Verify the API key or OAuth token and the Authorization header, then retry.' + retryable: 'no' + payment_required: + http_status: 402 + summary: The account must be credited or upgraded to perform this action. + cause: 'The action requires a paid plan, additional quota, or API credits.' + remediation: 'Upgrade the plan or add the required credits/quota, then retry.' + retryable: 'no' + forbidden: + http_status: 403 + summary: The action is not allowed for these credentials or in the current context. + cause: The authenticated account lacks access to the resource or operation. + remediation: Confirm the account has access to the resource and the required permissions. + retryable: 'no' + not_found: + http_status: 404 + summary: Nothing matches the requested resource. + cause: The resource id does not exist or is not visible to this account. + remediation: Verify the id and that the resource belongs to the authenticated account. + retryable: 'no' + conflict: + http_status: 409 + summary: The request was well-formed but conflicts with the current state. + cause: The target resource is in a state incompatible with the request (e.g. a signature request is still being set up). + remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready.' + retryable: conditional + exceeded_rate: + http_status: 429 + summary: Your account's API request rate limit has been exceeded. + cause: Too many requests were sent within the rate-limit window for this request type. + remediation: 'Pace requests using the X-RateLimit-* response headers and retry after the window resets.' + retryable: 'yes' + backoff: Honor X-Ratelimit-Reset (Unix epoch); otherwise exponential backoff with jitter. No Retry-After header is sent. + unknown: + http_status: 500 + summary: An unexpected error occurred. + cause: 'An unhandled server-side error, or a status code without a more specific error_name.' + remediation: 'Retry transient failures; if it persists, contact support with the request details.' + retryable: conditional + backoff: 'For transient 5xx, retry with exponential backoff; otherwise do not retry.' + team_invite_failed: + http_status: 403 + summary: The team invitation could not be completed. + cause: 'The invitee already belongs to a team, or the invite is otherwise not permitted.' + remediation: Confirm the invitee is not already on a team before inviting. + retryable: 'no' + max_faxes: + http_status: 429 + summary: Too many fax transmissions are currently pending or transmitting. + cause: The account has reached the limit of concurrent in-flight fax transmissions. + remediation: 'Wait for outstanding transmissions to complete, then retry.' + retryable: 'yes' + backoff: Retry with exponential backoff once pending transmissions clear. + invalid_recipient: + http_status: 400 + summary: The recipient (fax number or email address) is invalid. + cause: A recipient value did not pass validation. + remediation: Correct the recipient value and resend. + retryable: 'no' + signature_request_cancel_failed: + http_status: 400 + summary: The signature request could not be cancelled. + cause: 'The caller is not the requester, or the request is already fully executed/closed.' + remediation: 'Only the requester can cancel, and only before the request is fully executed.' + retryable: 'no' + signature_request_remove_failed: + http_status: 400 + summary: Access to the signature request could not be removed. + cause: 'The signature request has not yet been fully executed, so access cannot be revoked.' + remediation: 'Wait until all parties have signed, or call /signature_request/cancel to cancel incomplete requests instead.' + retryable: 'no' + maintenance: + http_status: 503 + summary: The request could not be completed because the site is under maintenance. + cause: The API is in a scheduled maintenance window. + remediation: Retry once the maintenance window ends. + retryable: 'yes' + backoff: Retry later with exponential backoff. + method_not_supported: + http_status: 405 + summary: The HTTP method is not supported for this endpoint. + cause: The request used a verb the endpoint does not accept. + remediation: Use the HTTP method documented for the endpoint. + retryable: 'no' + invalid_reminder: + http_status: 400 + summary: The signature request reminder was invalid. + cause: A reminder was attempted against an ineligible request (e.g. embedded, closed, or expired). + remediation: Only send reminders for eligible (non-embedded, open) signature requests. + retryable: 'no' + unavailable: + http_status: 503 + summary: The service is temporarily unavailable. + cause: A downstream dependency or the service itself is temporarily unavailable. + remediation: Retry later with exponential backoff. + retryable: 'yes' + backoff: Retry later with exponential backoff and jitter. + unprocessable_entity: + http_status: 422 + summary: The request was understood but the target entity cannot be processed. + cause: 'The resource is still being processed, or it is in an error state.' + remediation: 'If the resource is still processing, wait and retry; if it is in an error state, recreate/resend it instead of retrying.' + retryable: conditional + backoff: 'If still processing, retry with exponential backoff; if in an error state, do not retry.' + signature_request_expired: + http_status: + - 400 + - 403 + summary: The signature request has expired. + cause: The operation targets a request whose expiration has passed. Most endpoints return 400; final-copy/download endpoints return 403. + remediation: The request can no longer be acted upon; create a new signature request. + retryable: 'no' + deleted: + http_status: 410 + summary: The request was cancelled or deleted. + cause: The resource has been cancelled or removed and is no longer available. + remediation: Do not retry; the resource is permanently gone. + retryable: 'no' +x-oauth-error-codes: + invalid_grant: + http_status: + - 400 + - 401 + summary: The OAuth grant (authorization code or refresh token) is invalid or expired. + cause: 'The code/token was already used, expired, or does not match the client.' + remediation: Re-initiate the OAuth flow to obtain a fresh authorization code. + retryable: 'no' + invalid_client: + http_status: 400 + summary: The OAuth client credentials are invalid. + cause: The client_id or client_secret is unrecognized or incorrect. + remediation: Verify the client_id and client_secret from the API app settings. + retryable: 'no' + invalid_request: + http_status: 400 + summary: The OAuth request is malformed or missing required parameters. + cause: 'A required parameter is missing, or the request format is invalid.' + remediation: Check the request against the OAuth token endpoint documentation. + retryable: 'no' + unauthorized_client: + http_status: + - 401 + - 403 + summary: The OAuth client is not authorized to perform this action. + cause: 'The app has not been approved, or the action is outside the granted scopes.' + remediation: Ensure the app is approved and the required scopes are granted. + retryable: 'no' + unsupported_grant_type: + http_status: 400 + summary: The grant type is not supported. + cause: The grant_type parameter value is not recognized. + remediation: Use authorization_code or refresh_token as the grant_type. + retryable: 'no' + payment_required: + http_status: 402 + summary: The account requires a paid plan to use this OAuth app. + cause: The authorizing account does not have a plan that supports this integration. + remediation: Upgrade the account to a plan that includes OAuth app access. + retryable: 'no' + addon_required: + http_status: 402 + summary: An add-on is required to use this OAuth app. + cause: The account plan does not include the add-on needed for this integration. + remediation: Add the required add-on to the account subscription. + retryable: 'no' + invalid_scope: + http_status: 400 + summary: The requested OAuth scope is invalid. + cause: The scope parameter contains values not permitted for the app. + remediation: Request only scopes that the app is configured to use. + retryable: 'no' + quota_reached: + http_status: 402 + summary: The account has reached its usage quota for this OAuth app. + cause: The authorizing account has exhausted its quota for the integration. + remediation: Contact the app owner or upgrade the account quota. + retryable: 'no' + server_error: + http_status: 500 + summary: An internal server error occurred during OAuth processing. + cause: An unexpected error on the server side while handling the OAuth request. + remediation: 'Retry the request; if it persists, contact support.' + retryable: 'yes' + backoff: Retry with exponential backoff. + temporary_unavailable: + http_status: 503 + summary: The OAuth service is temporarily unavailable. + cause: The service is under maintenance or experiencing temporary issues. + remediation: Retry after a short delay. + retryable: 'yes' + backoff: Retry with exponential backoff. +x-error-events: + signature_request_invalid: + event_type: signature_request_invalid + delivery: webhook + summary: Asynchronous error while processing a signature request. + cause: A signature request could not be processed (e.g. invalid tags, fields, or merge data). + remediation: 'Inspect event.event_metadata.event_message in the callback, correct the request, and resend.' + retryable: conditional + unknown_error: + event_type: unknown_error + delivery: webhook + summary: An unspecified asynchronous processing error occurred. + cause: An unexpected error occurred while processing the request asynchronously. + remediation: Check the request status in the API dashboard; retry or contact support if it persists. + retryable: conditional + file_error: + event_type: file_error + delivery: webhook + summary: Asynchronous error while processing an uploaded file. + cause: A file attached to a request could not be processed. + remediation: 'Resend the request with a supported, non-corrupt file.' + retryable: conditional + template_error: + event_type: template_error + delivery: webhook + summary: Asynchronous error while creating a template. + cause: Template file processing failed (e.g. unsupported or corrupt file). + remediation: Recreate the template with a valid file; check status in the API dashboard. + retryable: conditional + sign_url_invalid: + event_type: sign_url_invalid + delivery: webhook + summary: An embedded signing URL has expired or become invalid. + cause: The embedded sign_url is no longer valid (e.g. expired). + remediation: Generate a fresh embedded sign_url via the embedded sign URL endpoint. + retryable: 'yes' diff --git a/src/Hello/OpenApi/FernOpenApiTransformer.php b/src/Hello/OpenApi/FernOpenApiTransformer.php new file mode 100644 index 000000000..722ab2c1e --- /dev/null +++ b/src/Hello/OpenApi/FernOpenApiTransformer.php @@ -0,0 +1,433 @@ + **Delivery format:** This payload is delivered to your callback URL as an HTTP " . + "`POST` with `Content-Type: multipart/form-data`. The JSON structure documented below is " . + "sent as the value of a single form field named `json`. The schema below describes that JSON value."; + + private const HTTP_METHODS = [ + 'get', + 'post', + 'put', + 'patch', + 'delete', + 'options', + 'head', + 'trace', + ]; + + /** @var array */ + private const DOCUMENTATION_URL_REWRITES = [ + 'https://www.hellosign.com/terms' => 'https://sign.dropbox.com/terms', + 'https://www.hellosign.com/features/electronic-id' => 'https://sign.dropbox.com/features/electronic-id', + ]; + + private string $rootDir; + + /** @var array */ + private array $refCache = []; + + public int $inlinedCodeSamples = 0; + + public int $inlinedFileRefs = 0; + + public int $normalizedCsharpSamples = 0; + + public int $promotedWebhooks = 0; + + /** @var list */ + public array $missingRefs = []; + + public function __construct(string $rootDir) + { + $this->rootDir = rtrim($rootDir, '/'); + } + + /** + * @param array $openapi + * @return array + */ + public function transform(array $openapi): array + { + $this->refCache = []; + $this->inlinedCodeSamples = 0; + $this->inlinedFileRefs = 0; + $this->normalizedCsharpSamples = 0; + $this->promotedWebhooks = 0; + $this->missingRefs = []; + + $this->inlineCodeSamples($openapi); + $this->inlineFileRefs($openapi); + $this->promoteFernWebhooks($openapi); + $this->consumeXWebhooks($openapi); + $this->applyDocumentationUrlRewrites($openapi); + + return $openapi; + } + + /** + * Fern docs use sign.dropbox.com for customer-facing links. + * + * @param array $openapi + */ + private function applyDocumentationUrlRewrites(array &$openapi): void + { + $this->walk($openapi, function (&$value): void { + if (!is_string($value)) { + return; + } + + $value = strtr($value, self::DOCUMENTATION_URL_REWRITES); + }); + } + + /** + * @param array $openapi + */ + private function inlineCodeSamples(array &$openapi): void + { + $this->walk($openapi, function (&$value): void { + if (!is_array($value) || !isset($value['x-codeSamples']) || !is_array($value['x-codeSamples'])) { + return; + } + + foreach ($value['x-codeSamples'] as &$sample) { + if (!is_array($sample)) { + continue; + } + + $lang = $sample['lang'] ?? null; + $shouldNormalizeSource = $this->shouldNormalizeSampleSource(is_string($lang) ? $lang : ''); + + if ($lang === 'C#') { + $sample['lang'] = 'csharp'; + $this->normalizedCsharpSamples += 1; + } + + $ref = $sample['source']['$ref'] ?? null; + if (!is_string($ref)) { + if ($shouldNormalizeSource && isset($sample['source']) && is_string($sample['source'])) { + $sample['source'] = $this->normalizeCodeSampleSource($sample['source']); + } + continue; + } + + $resolved = $this->resolveRefPath($ref); + try { + $source = $this->readCachedRef($resolved); + $sample['source'] = $shouldNormalizeSource + ? $this->normalizeCodeSampleSource($source) + : $source; + $this->inlinedCodeSamples += 1; + } catch (\RuntimeException $error) { + $this->missingRefs[] = [ + 'ref' => $ref, + 'resolved' => $resolved, + 'error' => $error->getMessage(), + ]; + } + } + unset($sample); + }); + } + + /** + * @param array $openapi + */ + private function inlineFileRefs(array &$openapi): void + { + $this->walk($openapi, function (&$value): void { + if (!is_array($value)) { + return; + } + + if ( + isset($value['description']) + && is_array($value['description']) + && isset($value['description']['$ref']) + && is_string($value['description']['$ref']) + && strpos($value['description']['$ref'], '#') !== 0 + ) { + $ref = $value['description']['$ref']; + $resolved = $this->resolveRefPath($ref); + try { + $value['description'] = rtrim($this->readCachedRef($resolved), " \t\n\r\0\x0B"); + $this->inlinedFileRefs += 1; + } catch (\RuntimeException $error) { + $this->missingRefs[] = [ + 'ref' => $ref, + 'resolved' => $resolved, + 'error' => $error->getMessage(), + ]; + } + } + + if ( + isset($value['value']) + && is_array($value['value']) + && isset($value['value']['$ref']) + && is_string($value['value']['$ref']) + && strpos($value['value']['$ref'], '#') !== 0 + ) { + $ref = $value['value']['$ref']; + $resolved = $this->resolveRefPath($ref); + try { + $value['value'] = $this->parseJsonLike($this->readCachedRef($resolved)); + $this->inlinedFileRefs += 1; + } catch (\RuntimeException $error) { + $this->missingRefs[] = [ + 'ref' => $ref, + 'resolved' => $resolved, + 'error' => $error->getMessage(), + ]; + } + } + }); + } + + /** + * @param array $openapi + */ + private function promoteFernWebhooks(array &$openapi): void + { + if (!isset($openapi['paths']) || !is_array($openapi['paths'])) { + return; + } + + $webhooks = isset($openapi['webhooks']) && is_array($openapi['webhooks']) + ? $openapi['webhooks'] + : []; + + foreach ($openapi['paths'] as $pathKey => &$pathItem) { + if (!is_array($pathItem)) { + continue; + } + + $webhookMethods = []; + foreach (self::HTTP_METHODS as $method) { + if ( + isset($pathItem[$method]) + && is_array($pathItem[$method]) + && ($pathItem[$method]['x-fern-webhook'] ?? false) === true + ) { + $webhookMethods[] = $method; + } + } + + if ($webhookMethods === []) { + continue; + } + + foreach ($webhookMethods as $method) { + $operation = $pathItem[$method]; + $this->prepareWebhookOperation($operation); + + $key = $operation['operationId'] ?? null; + if (!is_string($key) || $key === '') { + $key = trim(preg_replace('/[^a-zA-Z0-9]+/', '_', (string) $pathKey) ?? '', '_'); + } + if ($key === '') { + $key = 'webhook_' . count($webhooks); + } + + $webhooks[$key] = [$method => $operation]; + unset($pathItem[$method]); + $this->promotedWebhooks += 1; + } + + $remainingMethods = []; + foreach (self::HTTP_METHODS as $method) { + if (isset($pathItem[$method]) && is_array($pathItem[$method])) { + $remainingMethods[] = $method; + } + } + + if ($remainingMethods === []) { + unset($openapi['paths'][$pathKey]); + } + } + unset($pathItem); + + if ($webhooks !== []) { + $openapi['webhooks'] = $webhooks; + } + } + + /** + * @param array $openapi + */ + private function consumeXWebhooks(array &$openapi): void + { + if (!isset($openapi['x-webhooks']) || !is_array($openapi['x-webhooks'])) { + unset($openapi['x-webhooks']); + return; + } + + $webhooks = isset($openapi['webhooks']) && is_array($openapi['webhooks']) + ? $openapi['webhooks'] + : []; + + foreach ($openapi['x-webhooks'] as $entryKey => $entry) { + if (!is_array($entry)) { + continue; + } + + foreach (self::HTTP_METHODS as $method) { + if (!isset($entry[$method]) || !is_array($entry[$method])) { + continue; + } + + $operation = $entry[$method]; + if (!isset($operation['requestBody']['content']) || !is_array($operation['requestBody']['content'])) { + continue; + } + + $this->prepareWebhookOperation($operation); + + $key = $operation['operationId'] ?? null; + if (!is_string($key) || $key === '') { + $key = trim(preg_replace('/[^a-zA-Z0-9]+/', '_', (string) $entryKey) ?? '', '_'); + } + if ($key === '') { + $key = 'webhook_' . count($webhooks); + } + + $webhooks[$key] = [$method => $operation]; + $this->promotedWebhooks += 1; + } + } + + unset($openapi['x-webhooks']); + + if ($webhooks !== []) { + $openapi['webhooks'] = $webhooks; + } + } + + /** + * @param array $operation + */ + private function prepareWebhookOperation(array &$operation): void + { + unset($operation['x-codeSamples'], $operation['x-fern-webhook']); + + if (!isset($operation['requestBody']) || !is_array($operation['requestBody'])) { + return; + } + + $existing = isset($operation['requestBody']['description']) && is_string($operation['requestBody']['description']) + ? $operation['requestBody']['description'] + : ''; + + if (strpos($existing, 'Delivery format') === false) { + $operation['requestBody']['description'] = $existing !== '' + ? $existing . self::WEBHOOK_DELIVERY_NOTE + : ltrim(self::WEBHOOK_DELIVERY_NOTE); + } + } + + /** + * @param mixed $value + */ + private function walk(&$value, callable $visitor): void + { + $visitor($value); + + if (!is_array($value)) { + return; + } + + foreach ($value as &$item) { + $this->walk($item, $visitor); + } + unset($item); + } + + private function resolveRefPath(string $ref): string + { + if (preg_match('#^https?://#i', $ref) === 1) { + return $ref; + } + + return $this->rootDir . '/' . ltrim($ref, './'); + } + + private function readCachedRef(string $resolved): string + { + if (!array_key_exists($resolved, $this->refCache)) { + if (preg_match('#^https?://#i', $resolved) === 1) { + throw new \RuntimeException('Remote refs are not supported'); + } + + if (!is_readable($resolved)) { + throw new \RuntimeException("File not readable: {$resolved}"); + } + + $contents = file_get_contents($resolved); + if ($contents === false) { + throw new \RuntimeException("Failed to read: {$resolved}"); + } + + $this->refCache[$resolved] = $contents; + } + + return $this->refCache[$resolved]; + } + + /** + * Preserve JSON object/array distinction. json_decode(..., true) turns {} into [] in PHP. + * + * @return mixed + */ + private function parseJsonLike(string $text) + { + $decoded = json_decode($text, false); + if (json_last_error() === JSON_ERROR_NONE) { + return $this->normalizeDecodedJson($decoded); + } + + return Yaml::parse($text); + } + + /** + * @return mixed + */ + private function normalizeDecodedJson($value) + { + if ($value instanceof \stdClass) { + $normalized = []; + foreach (get_object_vars($value) as $key => $item) { + $normalized[$key] = $this->normalizeDecodedJson($item); + } + + return $normalized === [] ? new \stdClass() : $normalized; + } + + if (is_array($value)) { + return array_map([$this, 'normalizeDecodedJson'], $value); + } + + return $value; + } + + private function shouldNormalizeSampleSource(string $lang): bool + { + return in_array($lang, ['C#', 'csharp', 'TypeScript', 'typescript', 'JavaScript', 'javascript', 'Node'], true); + } + + private function normalizeCodeSampleSource(string $source): string + { + return preg_replace("/^(\s*)'y':/m", '$1y:', $source) ?? $source; + } +} diff --git a/src/Hello/OpenApi/FernOpenApiWriter.php b/src/Hello/OpenApi/FernOpenApiWriter.php new file mode 100644 index 000000000..9b27f8327 --- /dev/null +++ b/src/Hello/OpenApi/FernOpenApiWriter.php @@ -0,0 +1,422 @@ + $openapi + */ + public function write(array $openapi, string $targetFile): void + { + $ordered = $this->orderTopLevel($openapi); + $this->ensureQuotedResponseKeys($ordered); + + $yaml = Yaml::dump( + $ordered, + self::DUMP_INLINE_DEPTH, + 2, + Yaml::DUMP_OBJECT_AS_MAP + ^ Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE + ^ Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK + ); + + $yaml = str_replace('value: []', 'value: {}', $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 ?? ''); + $yaml = $this->expandFlowStyleCollections($yaml ?? ''); + $yaml = $this->normalizeYamlText($yaml); + + file_put_contents($targetFile, $yaml); + } + + /** + * Symfony dumps numeric response keys without quotes; Fern/historical output keeps them quoted. + * + * @param array $value + */ + private function ensureQuotedResponseKeys(array &$value): void + { + if (!is_array($value)) { + return; + } + + if (isset($value['responses']) && is_array($value['responses'])) { + $responses = []; + foreach ($value['responses'] as $code => $response) { + $responses[(string) $code] = $response; + } + $value['responses'] = $responses; + } + + foreach ($value as &$item) { + if (is_array($item)) { + $this->ensureQuotedResponseKeys($item); + } + } + unset($item); + } + + /** + * @param array $value + * @return array + */ + private function orderTopLevel(array $value): array + { + $ordered = []; + + foreach (self::TOP_LEVEL_KEY_ORDER as $key) { + if (array_key_exists($key, $value)) { + $ordered[$key] = $value[$key]; + } + } + + foreach ($value as $key => $item) { + if (!array_key_exists($key, $ordered)) { + $ordered[$key] = $item; + } + } + + return $ordered; + } + + /** + * Symfony falls back to JSON-style flow collections at deep nesting; expand them to block YAML. + */ + private function expandFlowStyleCollections(string $text): string + { + $expanded = []; + + foreach (explode("\n", $text) as $line) { + array_push($expanded, ...$this->expandFlowStyleLine($line)); + } + + return implode("\n", $expanded); + } + + /** + * @return list + */ + private function expandFlowStyleLine(string $line): array + { + if (preg_match('/^(\s+)([\w.-]+):\s*\{\s*\}\s*(#.*)?$/', $line, $match)) { + $suffix = isset($match[3]) ? ' ' . $match[3] : ''; + + return [$match[1] . $match[2] . ': {}' . $suffix]; + } + + if (preg_match('/^(\s+)([\w.-]+):\s*\[\]\s*(#.*)?$/', $line, $match)) { + $suffix = isset($match[3]) ? ' ' . $match[3] : ''; + + return [$match[1] . $match[2] . ': []' . $suffix]; + } + + if (preg_match('/^(\s+)([\w.-]+):\s*\[(.*)\]\s*(#.*)?$/', $line, $match)) { + $items = $this->parseFlowSequenceItems($match[3]); + if ($items === null) { + return [$line]; + } + + $lines = [$match[1] . $match[2] . ':']; + foreach ($items as $item) { + $lines[] = $match[1] . ' - ' . $item; + } + + return $lines; + } + + if (preg_match('/^(\s+)([\w.-]+):\s*\{(.+)\}\s*(#.*)?$/', $line, $match)) { + $pairs = $this->parseFlowMappingPairs($match[3]); + if ($pairs === null) { + return [$line]; + } + + $lines = [$match[1] . $match[2] . ':']; + foreach ($pairs as [$key, $value]) { + $lines[] = $match[1] . ' ' . $key . ': ' . $value; + } + + return $lines; + } + + return [$line]; + } + + /** + * @return list|null + */ + private function parseFlowSequenceItems(string $content): ?array + { + $content = trim($content); + if ($content === '') { + return []; + } + + if (preg_match('/[\[{]/', $content)) { + return null; + } + + $items = preg_split('/\s*,\s*/', $content); + + return $items === false ? null : $items; + } + + /** + * @return list|null + */ + private function parseFlowMappingPairs(string $content): ?array + { + $content = trim($content); + if ($content === '') { + return []; + } + + if (preg_match('/[\[{]/', $content)) { + return null; + } + + $pairs = []; + foreach (preg_split('/\s*,\s*/', $content) as $segment) { + if (!preg_match('/^([\w.-]+):\s*(.+)$/', $segment, $part)) { + return null; + } + + $pairs[] = [$part[1], $part[2]]; + } + + return $pairs; + } + + private function normalizeYamlText(string $text): string + { + $lines = explode("\n", $text); + $normalized = []; + $blockScalarIndent = null; + + for ($i = 0, $count = count($lines); $i < $count; $i += 1) { + $rawLine = $lines[$i]; + $lineIndent = strlen($rawLine) - strlen(ltrim($rawLine)); + $isBlank = trim($rawLine) === ''; + + if ($blockScalarIndent !== null && !$isBlank && $lineIndent <= $blockScalarIndent) { + $blockScalarIndent = null; + } + + $outsideBlockScalar = $blockScalarIndent === null; + + if ($outsideBlockScalar) { + $collapsedItem = $this->collapseExpandedSequenceItem($rawLine, $lines[$i + 1] ?? null); + if ($collapsedItem !== null) { + $normalized[] = $this->quoteAmbiguousPlainKey( + $this->unquotePathKey( + $this->unquoteSimpleListItem( + $this->unquoteSimpleScalar($this->quoteResponseStatusKey($collapsedItem)) + ) + ) + ); + $i += 1; + continue; + } + } + + $line = $outsideBlockScalar + ? $this->quoteAmbiguousPlainKey( + $this->unquotePathKey( + $this->unquoteSimpleListItem( + $this->unquoteSimpleScalar($this->quoteResponseStatusKey($rawLine)) + ) + ) + ) + : $rawLine; + $nextLine = $lines[$i + 1] ?? null; + $collapsed = $outsideBlockScalar ? $this->collapseEmptyCollection($line, $nextLine) : null; + + if ($collapsed !== null) { + $normalized[] = $collapsed; + $i += 1; + continue; + } + + $normalized[] = $line; + + if ($outsideBlockScalar && $this->isBlockScalarHeader($line)) { + $blockScalarIndent = $lineIndent; + } + } + + return implode("\n", $normalized); + } + + private function quoteResponseStatusKey(string $line): string + { + return preg_replace("/^(\s+)(\d+):/", "$1'$2':", $line) ?? $line; + } + + private function unquotePathKey(string $line): string + { + if (!preg_match("/^(\s*)'(\/[^']*)':\s*$/", $line, $match)) { + return $line; + } + + return $match[1] . $match[2] . ':'; + } + + private function unquoteSimpleListItem(string $line): string + { + if (!preg_match("/^(\s*- )'([^']*(?:''[^']*)*)'(\s*(?:#.*)?)$/", $line, $match)) { + return $line; + } + + $value = str_replace("''", "'", $match[2]); + if (!$this->canUsePlainScalar($value)) { + return $line; + } + + return $match[1] . $value . $match[3]; + } + + private function unquoteSimpleScalar(string $line): string + { + if (!preg_match("/^(\s*(?:-\s*)?[\w.-]+:\s*)'((?:[^']|'')*)'(\s*(?:#.*)?)$/", $line, $match)) { + return $line; + } + + $value = str_replace("''", "'", $match[2]); + if (!$this->canUsePlainScalar($value)) { + return $line; + } + + return $match[1] . $value . $match[3]; + } + + private function canUsePlainScalar(string $value): bool + { + if ($value === '') { + return false; + } + + if (preg_match('/[\n\r]/', $value)) { + return false; + } + + if (preg_match('/^\s/', $value) || preg_match('/\s$/', $value)) { + return false; + } + + if (preg_match('/^https?:\/\//', $value)) { + return true; + } + + if ($value === 'C#') { + return true; + } + + if (preg_match('/^\[.*\]$/', $value)) { + return false; + } + + if (preg_match('/[\[\]()|]/', $value)) { + return strpos($value, ': ') === false; + } + + if (preg_match('/[\[\]{}&,*!>"%@]/', $value)) { + return false; + } + + if (preg_match('/:\s/', $value)) { + return false; + } + + if (preg_match('/#/', $value)) { + return false; + } + + if (in_array(strtolower($value), ['true', 'false', 'null', 'yes', 'no', 'on', 'off', 'y'], true)) { + return false; + } + + if (preg_match('/^-?\d+(?:\.\d+)?$/', $value)) { + return false; + } + + return true; + } + + private function collapseExpandedSequenceItem(string $line, ?string $nextLine): ?string + { + if ($nextLine === null || !preg_match('/^(\s+)-\s*$/', $line, $dash)) { + return null; + } + + if (!preg_match('/^(\s+)(\w.+)$/', $nextLine, $child)) { + return null; + } + + if ($child[1] !== $dash[1] . ' ') { + return null; + } + + return $dash[1] . '- ' . $child[2]; + } + + private function isBlockScalarHeader(string $line): bool + { + return (bool) preg_match('/:\s*[>|][+-]?\s*(?:#.*)?$/', $line); + } + + private function collapseEmptyCollection(string $line, ?string $nextLine): ?string + { + if ($nextLine === null) { + return null; + } + + if (!preg_match('/^(\s*(?:-\s*)?[^#\n][^:\n]*):\s*$/', $line, $parent)) { + return null; + } + + if (!preg_match('/^(\s+)(\{\}|\[\])\s*$/', $nextLine, $child)) { + return null; + } + + $parentIndent = strlen($parent[1]) - strlen(ltrim($parent[1])); + $childIndent = strlen($child[1]); + + if ($childIndent <= $parentIndent) { + return null; + } + + return $parent[1] . ': ' . $child[2]; + } + + private function quoteAmbiguousPlainKey(string $line): string + { + $line = preg_replace('/^(\s*)y:/', '$1\'y\':', $line) ?? $line; + $line = preg_replace('/^(\s*-\s*)y$/', '$1\'y\'', $line) ?? $line; + $line = preg_replace('/^(\s*-\s*)ON$/', '$1\'ON\'', $line) ?? $line; + + return $line; + } +} diff --git a/src/Hello/OpenApi/GenerateFernOas.php b/src/Hello/OpenApi/GenerateFernOas.php new file mode 100644 index 000000000..f71c52246 --- /dev/null +++ b/src/Hello/OpenApi/GenerateFernOas.php @@ -0,0 +1,48 @@ +transform($openapi); + + $writer = new FernOpenApiWriter(); + $writer->write($transformed, $outputFile); + + echo "Created Fern OpenAPI file at openapi-fern.yaml\n"; + echo " Inlined code sample refs: {$transformer->inlinedCodeSamples}\n"; + echo " Inlined file refs: {$transformer->inlinedFileRefs}\n"; + echo " Normalized C# samples: {$transformer->normalizedCsharpSamples}\n"; + echo " Promoted webhooks: {$transformer->promotedWebhooks}\n"; + + if ($transformer->missingRefs !== []) { + echo " Missing refs: " . count($transformer->missingRefs) . "\n"; + foreach ($transformer->missingRefs as $missing) { + echo " - {$missing['ref']} -> {$missing['resolved']}: {$missing['error']}\n"; + } + + throw new \RuntimeException('Fern OpenAPI generation completed with missing refs.'); + } + } +} diff --git a/test_fixtures/FileResponse.json b/test_fixtures/FileResponse.json index 42417f55c..e38e42f56 100644 --- a/test_fixtures/FileResponse.json +++ b/test_fixtures/FileResponse.json @@ -1,6 +1,6 @@ { "default": { - "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=AKIAJWEWDFQHQMBECJZA&Expires=1452868903&Signature=M%2FNDS%2BQre8xjPvzm7fHf%2BjO8Zbc%3D", + "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=EXAMPLE_ACCESS_KEY_ID&Expires=1452868903&Signature=EXAMPLE_SIGNATURE", "expires_at": 1458605123 } }